Class ARSession

Controls the lifecycle and configuration options for an AR session. There is only one active session. If you have multiple ARSession components, they all talk to the same session and will conflict with each other.

Enabling or disabling the ARSession will start or stop the session, respectively.

Inheritance

System.Object

ARSession

Namespace: UnityEngine.XR.ARFoundation

Syntax

public class ARSession : MonoBehaviour

Properties

lightEstimation

When enabled, requests that light estimation information be made available. Not all AR devices support light estimation.

Declaration

public bool lightEstimation { get; set; }

Property Value

Type	Description
System.Boolean

sessionTimeoutInSeconds

Get or set the session timeout.

Declaration

public float sessionTimeoutInSeconds { get; set; }

Property Value

Type	Description
System.Single

Remarks

If the session does not respond within this time, the subsystems are stopped and an error is assumed to have occurred. Listen for session state changes by subscribing to sessionStateChanged.