Class XRSessionSubsystem.Provider

The API this subsystem uses to interop with different provider implementations.

Inheritance

object

SubsystemProvider

SubsystemProvider<XRSessionSubsystem>

XRSessionSubsystem.Provider

Inherited Members

SubsystemProvider<XRSessionSubsystem>.TryInitialize()

SubsystemProvider.running

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: solution.dll

Syntax

public class XRSessionSubsystem.Provider : SubsystemProvider<XRSessionSubsystem>

Properties

Name	Description
currentTrackingMode	Get the current tracking mode (for example, the AnyTrackingMode bits).
frameRate	The native update rate of the AR Session. Must be implemented if supportsMatchFrameRate is True.
matchFrameRateEnabled	Whether the AR session update is synchronized with the Unity frame rate. If true, Update(XRSessionUpdateParams) will block until the next AR frame is available.
matchFrameRateRequested	Whether the AR session update should be synchronized with the Unity frame rate. If true, Update(XRSessionUpdateParams) should block until the next AR frame is available. Must be implemented if supportsMatchFrameRate is True.
nativePtr	Get a pointer to an object associated with the session. Callers should be able to manipulate the session in their own code using this.
notTrackingReason	Get the NotTrackingReason for the session.
requestedFeatures	Should return the features requested by the enabling of other Subsystems.
requestedTrackingMode	Get or set the requested tracking mode (for example, the AnyTrackingMode bits).
sessionId	Get a unique identifier for this session.
trackingState	Get the TrackingState for the session.

Methods

Name	Description
Destroy()	Stop the session and destroy all associated resources.
GetAvailabilityAsync()	Get the session's availability, such as whether the platform supports XR.
GetConfigurationDescriptors(Allocator)	This getter should allocate a new NativeArray using allocator and populate it with the supported ConfigurationDescriptors.
InstallAsync()	Attempt to update or install necessary XR software. Will only be called if supportsInstall is true.
OnApplicationPause()	Invoked when the application is paused.
OnApplicationResume()	Invoked when the application is resumed.
Reset()	Reset the session. The behavior should be equivalent to destroying and recreating the session.
Start()	Invoked to start or resume a session. This is different from OnApplicationResume().
Stop()	Invoked to pause a running session. This is different from OnApplicationPause().
Update(XRSessionUpdateParams)	Perform any per-frame update logic here.
Update(XRSessionUpdateParams, Configuration)	Perform any per-frame update logic here. The session should use the configuration indicated by configuration.descriptor.identifier.descriptor.identifier, which should be one of the ones returned by GetConfigurationDescriptors(Allocator).