XR

Session Manager

The session manager is subordinate to the XRManager instance, which you can access through xrManager.sessionManager.

Properties

PropertyTypeDescription
modeXRSessionMode(Read-only) Get the current session type
stateXRSessionState(Read-only) Get the current session state
supportedFrameRateFloat32Array(Read-only) Get the hardware-supported frame rate
frameRatenumber(Read-only) Get the hardware running frame rate

Methods

MethodDescription
isSupportedModeGet whether the session type is supported
runRun the session
stopStop the session

After entering an XR session, developers can run or stop the session at any time. It is important to note that this state does not affect the engine's run and pause.

Last updated on July 17, 2024

Was this page helpful?

On this page