docs.unity3d.com
    Show / Hide Table of Contents

    Enum ARSessionState

    Represents the current state of the AR system.

    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    public enum ARSessionState

    Fields

    Name Description Value
    None

    AR has not been initialized and availability is unknown. You can call CheckAvailability() to check availability of AR on the device.


    0
    Unsupported

    AR is not supported on the device.


    1
    CheckingAvailability

    The session subsystem is currently checking availability of AR on the device. The CheckAvailability() coroutine has not yet completed.


    2
    NeedsInstall

    The device supports AR, but requires additional software to be installed. If the provider supports runtime installation, you can call Install() to attempt installation of AR software on the device.


    3
    Installing

    AR software is currently installing. The Install() coroutine has not yet completed.


    4
    Ready

    The device supports AR, and any necessary software is installed. This state will automatically change to either SessionInitializing or SessionTracking.


    5
    SessionInitializing

    The AR session is currently initializing. This usually means AR is running, but not yet tracking successfully.


    6
    SessionTracking

    The AR session is running and tracking successfully. The device is able to determine its position and orientation in the world. If tracking is lost during a session, this state may change to SessionInitializing.


    7
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023