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

Default component screenshot.

alt text

Runtime component screenshot.

Property Description
Auto start Controls whether the session starts automatically. If the value is true (default), the session will start 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, etc.) on custom cameras or headsets, EasyAR Sense will stop responding after 100 seconds (Mega users can adjust the duration after approval by EasyAR business) upon each startup. There is no such limitation when using the paid version of EasyAR Sense and the paid EasyAR Mega service.
        Frame source FrameSource selection strategy:
  • Auto (default): Automatically selects the first available and active child node.
  • Manual: Manually specified. Requires selecting a frame source for the session in the expanded options.
  • FramePlayer: Selects the frame player.
See: Frame data source
        Frame filter FrameFilter selection strategy:
  • Auto (default): Automatically selects all active child nodes.
  • AutoAvailable: Automatically selects all active and available child nodes.
  • Manual: Manually specified. Requires selecting a set of frame filters for the session in the expanded options.
  • None: No selection.
        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.
If the download is not completed within the wait time, it will continue, and updates will be provided via events once the download is complete.
                Ignore cache Ignores the cache, forcing a download regardless of whether the current process has recently downloaded it.
Center AR center mode:
  • FirstTarget (default): Centers on the first tracked target.
  • Camera: Centers on ARAssembly.Camera.
  • SpecificTarget: Centers on the manually specified target.
  • SessionOrigin: Centers on ARSession.Origin.
During editor runtime, updates with the session state and changes take effect immediately.
See: Center mode
        Target Manually specified center object.
During editor runtime, updates with the session state and changes take effect immediately.
        Current During runtime, indicates the center object currently being used by the session.
Horizontal flip Horizontal mirror rendering mode. Only available when using image or object tracking.
During editor runtime, updates with the session state and changes take effect immediately.
        Back camera Horizontal mirror rendering mode for the rear camera:
  • None (default): No flipping.
  • World: Horizontal mirror rendering, the camera image will be mirrored, the camera projection matrix will change for mirror rendering, and the target scale will not change.
  • Target: Horizontal mirror rendering, the camera image will be mirrored, the target scale will change for mirror rendering, and the camera projection matrix will not change.
        Front camera Horizontal mirror rendering mode for the front camera:
  • None: No flipping.</