Table of Contents

Ar session component reference

Switch to API

Explore the properties in the AR Session component window to customize session parameters.

alt text

Component screenshot under default conditions.

alt text

Component screenshot at runtime.

Property Description
Auto start Controls whether the session starts automatically. If true (default), the session starts automatically at MonoBehaviour.Start().
See: session flow control
Assemble options Session assembly options.
        Enable custom camera Enable custom camera (default true).
Custom cameras include: AR Engine frame source, AR Foundation frame source, all headsets, and all custom frame sources.
When using trial products (such as personal edition license, trial XR license, or trial Mega service) on custom cameras or headsets, EasyAR Sense will stop responding 100 seconds after each startup (the duration can be adjusted via EasyAR Business upon approval for Mega users). Using the paid version of EasyAR Sense and the paid EasyAR Mega service does not have this restriction.
        Frame source FrameSource selection strategy:
  • Auto (default): Automatic selection, chooses the first available and active child node.
  • Manual: Manually specified. Requires selecting a frame source for the session within the expanded option.
  • FramePlayer: Select frame player.
See: frame data source
        Frame filter FrameFilter selection strategy:
  • Auto (default): Automatic selection. Selects all active child nodes.
  • AutoAvailable: Automatic selection. Selects all active and available child nodes.
  • Manual: Manually specified. Requires selecting a set of frame filters for the session within the expanded option.
  • None: Select none.
        Device list update options Device list update options.
See: determining availability and device support
                Timeout Request timeout, in seconds.
                Wait time Wait time, in seconds.
Proceeds even if download is incomplete after this time; updates via event upon later completion.
                Ignore cache Ignore cache, forces download regardless of recent downloads in the current process.
Center AR center mode:
  • FirstTarget (default): Centers on the first tracked target.
  • Camera: Centers on the ARAssembly.Camera.
  • SpecificTarget: Centers on the manually specified target.
  • SessionOrigin: Centers on the ARSession.Origin.
Updates immediately and takes effect in real-time when running in the editor.
See: center mode
        Target Manually specified center object.
Updates immediately and takes effect in real-time when running in the editor.
        Current Represents the center object currently in use by the session at runtime.
Horizontal flip Horizontal flip rendering mode. Only available when using image or object tracking.
Updates immediately and takes effect in real-time when running in the editor.
        Back camera Horizontal flip rendering mode for rear camera:
  • None (default): No flip.
  • World: Horizontal flip rendering. Camera image is mirrored, camera projection matrix changes for flipped rendering, target scale remains unchanged.
  • Target: Horizontal flip rendering. Camera image is mirrored, target scale changes for flipped rendering, camera projection matrix remains unchanged.
        Front camera Horizontal flip rendering mode for front camera:
  • None: No flip.
  • World (default): Horizontal flip rendering. Camera image is mirrored, camera projection matrix changes for flipped rendering, target scale remains unchanged.
  • Target: Horizontal flip rendering. Camera image is mirrored, target scale changes for flipped rendering, camera projection matrix remains unchanged.