←API Reference

XRSubsystems

---

Classes

Name	Type	Summary
ObjectDetectionUtilities	ObjectDetectionUtilities	-
Provider	SubsystemProvider<XRVps2Subsystem>	-
Provider	SubsystemProvider<XRDeviceMappingSubsystem>	-
Provider	SubsystemProvider<XRPersistentAnchorSubsystem>	An abstract class to be implemented by providers of this subsystem.
Provider	SubsystemProvider<XRObjectDetectionSubsystem>	The provider which will service the XRObjectDetectionSubsystem.
Provider	SubsystemProvider<XRWorldPositioningSubsystem>	The provider which will service the XRWorldPositioningSubsystem.
Provider	SubsystemProvider<XRSceneSegmentationSubsystem>	The provider which will service the XRSceneSegmentationSubsystem.
Provider	SubsystemProvider<XRScanningSubsystem>	An abstract class to be implemented by providers of this subsystem.
XRDetectedObject	XRDetectedObject	A class representing an object in the XR camera's view detected by the object detection model.
XRDeviceMappingSubsystem	SubsystemWithProvider<XRDeviceMappingSubsystem, XRDeviceMappingSubsystemDescriptor, Provider>	-
XRDeviceMappingSubsystemDescriptor	SubsystemDescriptorWithProvider<XRDeviceMappingSubsystem, Provider>	-
XRObjectDetectionSubsystem	SubsystemWithProvider<XRObjectDetectionSubsystem, XRObjectDetectionSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata	Defines an interface for interacting with object detection functionality.
XRObjectDetectionSubsystemDescriptor	SubsystemDescriptorWithProvider<XRObjectDetectionSubsystem, Provider>	Descriptor for the XRSceneSegmentationSubsystem.
XRPersistentAnchorConfiguration	XRPersistentAnchorConfiguration	Configuration for PersistentAnchorSubsystem.
XRPersistentAnchorSubsystem	TrackingSubsystem<XRVps2Anchor, XRPersistentAnchorSubsystem, XRPersistentAnchorSubsystemDescriptor, Provider>	Base class for a persistent anchor subsystem.
XRPersistentAnchorSubsystemDescriptor	SubsystemDescriptorWithProvider<XRPersistentAnchorSubsystem, Provider>	Descriptor for the XRPersistentAnchorSubsystem.
XRScanningConfiguration	XRScanningConfiguration	Configuration for scanning.
XRScanningSubsystem	SubsystemWithProvider<XRScanningSubsystem, XRScanningSubsystemDescriptor, Provider>	Defines an interface for interacting with scanning functionality.
XRScanningSubsystemDescriptor	SubsystemDescriptorWithProvider<XRScanningSubsystem, Provider>	-
XRSceneSegmentationSubsystem	SubsystemWithProvider<XRSceneSegmentationSubsystem, XRSceneSegmentationSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata	Defines an interface for interacting with semantic segmentation functionality.
XRSceneSegmentationSubsystemDescriptor	SubsystemDescriptorWithProvider<XRSceneSegmentationSubsystem, Provider>	Descriptor for the XRSceneSegmentationSubsystem.
XRVps2Subsystem	TrackingSubsystem<XRVps2Anchor, XRVps2Subsystem, XRVps2SubsystemDescriptor, Provider>	-
XRVps2SubsystemDescriptor	SubsystemDescriptorWithProvider<XRVps2Subsystem, Provider>	Descriptor for the XRVps2Subsystem.
XRWorldPositioningSubsystem	SubsystemWithProvider<XRWorldPositioningSubsystem, XRWorldPositioningSubsystemDescriptor, Provider>	Defines an interface for interacting with World Space functionality.
XRWorldPositioningSubsystemDescriptor	SubsystemDescriptorWithProvider<XRWorldPositioningSubsystem, Provider>	Descriptor for the XRWorldPositioningSubsystem.

---

Structs

Name	Type	Summary
Cinfo	ValueType, IEquatable<Cinfo>	-
Cinfo	ValueType, IEquatable<Cinfo>	Constructor info used to register a descriptor.
Cinfo	ValueType, IEquatable<Cinfo>	Constructor info used to register a descriptor.
XRGeolocation	ValueType	Structure describing device location and heading.
XRObjectCategorization	ValueType	A structure representing an object detection categorization. The object detection algorithm surfaces at least one categorization per detected object, but usually there are multiple categorizations.
XRObjectDetectionSubsystemCinfo	ValueType, IEquatable<XRObjectDetectionSubsystemCinfo>	Constructor parameters for the XRObjectDetectionSubsystemDescriptor.
XRPersistentAnchorDebugInfo	ValueType	Contains debug information of XRPersistentAnchorSubsystem
XRPersistentAnchorFrameDiagnostics	ValueType	Diagnostic information about frames used for localization
XRPersistentAnchorLocalizationStatus	ValueType	Reports the result of a localization request.
XRPersistentAnchorNetworkRequestStatus	ValueType	Diagnostic information about a persistent anchor network request
XRPersistentAnchorPayload	ValueType, IEquatable<XRPersistentAnchorPayload>	Represents the payload for a persistent anchor.
XRScanningVoxelData	ValueType, IEquatable<XRScanningVoxelData>	Contains a native voxel buffers for positions and colors.
XRSceneSegmentationSubsystemCinfo	ValueType, IEquatable<XRSceneSegmentationSubsystemCinfo>	Constructor parameters for the XRSceneSegmentationSubsystemDescriptor.
XRVps2Anchor	ValueType, ITrackable, IEquatable<XRVps2Anchor>	Describes session-relative data for an anchor.
XRVps2Geolocation	ValueType	Structure describing device location and heading as calculated by VPS2.
XRVps2Localization	ValueType, IEquatable<XRVps2Localization>	Spatial mapping between the device’s AR coordinate space and real-world geolocation, as determined by VPS2.
XRVps2LocalizationRequestRecord	ValueType	Diagnostic information about a VPS2 network request.
XRVps2Pose	ValueType	Structure describing device location in local AR coordinate space as calculated by VPS2.
XRVps2SubsystemCinfo	ValueType, IEquatable<XRVps2SubsystemCinfo>	Constructor parameters for the XRVps2SubsystemDescriptor.
XRWorldPositioningSubsystemCinfo	ValueType, IEquatable<XRWorldPositioningSubsystemCinfo>	Constructor parameters for the XRWorldPositioningSubsystemDescriptor.

---

Enums

Name	Type	Summary
DiagnosticLabel	uint	Labels that describe possible issues with frame
LocalizationStatus	byte	Reports the status of a localization request (may contain multiple client -> server requests) A limited localization means that localization returned a value, but there is not enough confidence to provide a meaningful pose.
RequestErrorCode	uint	Reports the error code of a localization network request, if any
RequestStatus	byte	Reports the status of a localization network request (single client -> server request).
RequestType	byte	Type of localization network request.
ScanningState	ScanningState	-
TrackingStateReason	uint	Provides further information about the tracking state of an anchor. Query this if the anchor's tracking state is NotTracking
Vps2LocalizationError	byte	Possible errors from VPS2 localization operations.
Vps2LocalizationRequestStatus	byte	-
Vps2LocalizationRequestType	byte	-
Vps2TrackingState	Vps2TrackingState	-
WorldPositioningStatus	WorldPositioningStatus	The WorldPositioningStatus represents the status of the AR to world transform. The transform should only be used when the status is Available.

---