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

attemptUpdate

If the device supports AR but does not have the necessary software, some platforms allow prompting the user to install or update the software. If attemptUpdate is true, a software update will be attempted. If the appropriate software is not installed or out of date, and attemptUpdate is false, then AR will not be available.

Declaration

public bool attemptUpdate { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Reset()

Resets the AR Session. This destroys the current session, including all trackables, and then establishes a new session.

Declaration

public void Reset()