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 the value is true (default), the session starts automatically at MonoBehaviour.Start().
See: session flow control
Assemble Options Assembly options for the session.
        Enable Custom Camera Enables custom cameras (default true).
Custom cameras include AR Engine frame source, AR Foundation frame source, all headsets, and all custom frame sources.
When using trial products on a custom camera or headset, such as a Personal license, trial XR license, or trial Mega service, EasyAR Sense stops responding 100 seconds after each startup. For Mega users, this duration can be adjusted after approval through EasyAR business. This limitation does not apply to paid versions of EasyAR Sense or paid EasyAR Mega services.
        Frame Source FrameSource selection strategy:
  • Auto (default): automatically select the first available and active child node.
  • Manual: specify manually. A frame source of the session must be selected in the expanded options.
  • FramePlayer: select frame player.
See: frame source
        Frame Filter FrameFilter selection strategy:
  • Auto (default): automatically select all active child nodes.
  • AutoAvailable: automatically select all active and available child nodes.
  • Manual: specify manually. A group of frame filters of the session must be selected in the expanded options.
  • None: select none.
        Device List Update Options Device list update options.
See: availability and device support
                Timeout Request timeout, in seconds.
                Wait Time Wait time, in seconds.
If the wait time is exceeded, execution continues even if the download has not completed. After the download completes, it is updated through events.
                Ignore Cache Ignore cache and force download regardless of whether the current process downloaded it recently.
Center AR center mode:
  • FirstTarget (default): uses the first tracked target as the center.
  • Camera: uses ARAssembly.Camera as the center.
  • SpecificTarget: uses the manually specified target as the center.
  • SessionOrigin: uses ARSession.Origin as the center.
When running in the editor, it updates with the session state and changes take effect immediately.
See: center mode
        Target Manually specified center object.
When running in the editor, it updates with the session state and changes take effect immediately.
        Current Indicates the center object currently used by the session at runtime.
Horizontal Flip Horizontal mirrored rendering mode. Available only when using image or object tracking.
When running in the editor, it updates with the session state and changes take effect immediately.
        Back Camera Horizontal mirrored rendering mode for the rear camera:
  • None (default): no flip.
  • World: horizontal mirrored rendering. The camera image is displayed mirrored, the camera projection matrix changes for mirrored rendering, and target scale does not change.
  • Target: horizontal mirrored rendering. The camera image is displayed mirrored, target scale changes for mirrored rendering, and the camera projection matrix does not change.
        Front Camera Horizontal mirrored rendering mode for the front camera:
  • None: no flip.
  • World (default): horizontal mirrored rendering. The camera image is displayed mirrored, the camera projection matrix changes for mirrored rendering, and target scale does not change.
  • Target: horizontal mirrored rendering. The camera image is displayed mirrored, target scale changes for mirrored rendering, and the camera projection matrix does not change.