Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-unity/NianticSpatial.NSDK.AR.XRSubsystems.txt — same content, easier to parse than this HTML, with each platform's steps kept separate.

Every page in the current release follows the same pattern, so you can build the URL directly instead of fetching an index: a page at /api/unity/<page>/ is at /llms-api-unity/<page>.txt.

For every page in this section, read https://www.nianticspatial.com/docs/llms-api-unity.txt; for every section of these docs, read https://www.nianticspatial.com/docs/llms.txt.

←API Reference

XRSubsystems

Classes

Name	Type	Summary
Provider	SubsystemProvider<XRVps2AnchorSubsystem>	The provider API for XRVps2AnchorSubsystem-derived classes to implement.
Provider	SubsystemProvider<XRVps2AssetSubsystem>	The provider API for XRVps2AssetSubsystem-derived classes to implement.
Provider	SubsystemProvider<XRVps2Subsystem>	-
Provider	SubsystemProvider<XRDeviceMappingSubsystem>	-
Provider	SubsystemProvider<XRSceneSegmentationSubsystem>	The provider which will service the XRSceneSegmentationSubsystem.
Provider	SubsystemProvider<XRScanningSubsystem>	An abstract class to be implemented by providers of this subsystem.
Vps2AssetId	Vps2AssetId	Conversions between VPS asset UUID strings and TrackableIds.
XRDeviceMappingSubsystem	SubsystemWithProvider<XRDeviceMappingSubsystem, XRDeviceMappingSubsystemDescriptor, Provider>	-
XRDeviceMappingSubsystemDescriptor	SubsystemDescriptorWithProvider<XRDeviceMappingSubsystem, Provider>	-
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.
XRVps2AnchorSubsystem	TrackingSubsystem<XRVps2Anchor, XRVps2AnchorSubsystem, XRVps2AnchorSubsystemDescriptor, Provider>	A tracking subsystem serving VPS2 anchors as trackables.
XRVps2AnchorSubsystemDescriptor	SubsystemDescriptorWithProvider<XRVps2AnchorSubsystem, Provider>	Descriptor for the XRVps2AnchorSubsystem.
XRVps2AssetSubsystem	TrackingSubsystem<XRVps2Asset, XRVps2AssetSubsystem, XRVps2AssetSubsystemDescriptor, Provider>	A tracking subsystem serving the origins of VPS assets as trackables.
XRVps2AssetSubsystemDescriptor	SubsystemDescriptorWithProvider<XRVps2AssetSubsystem, Provider>	Descriptor for the XRVps2AssetSubsystem.
XRVps2Subsystem	SubsystemWithProvider<XRVps2Subsystem, XRVps2SubsystemDescriptor, Provider>	The subsystem owning the VPS2 feature's lifecycle: configuration, localization, and geolocation. Anchors and asset origins are served by the XRVps2AnchorSubsystem and XRVps2AssetSubsystem trackable subsystems, which run against the feature this subsystem manages.
XRVps2SubsystemDescriptor	SubsystemDescriptorWithProvider<XRVps2Subsystem, Provider>	Descriptor for the XRVps2Subsystem.

Structs

Name	Type	Summary
Cinfo	ValueType, IEquatable<Cinfo>	-
Cinfo	ValueType, IEquatable<Cinfo>	Constructor info used to register a descriptor.
Vps2LocalizedAsset	ValueType, IEquatable<Vps2LocalizedAsset>	The VPS asset the device is localized to.
XRGeolocation	ValueType	Structure describing device location and heading.
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.
XRVps2AnchorPayload	ValueType, IEquatable<XRVps2AnchorPayload>	Represents the payload for a persistent anchor.
XRVps2AnchorSubsystemCinfo	ValueType, IEquatable<XRVps2AnchorSubsystemCinfo>	Constructor parameters for the XRVps2AnchorSubsystemDescriptor.
XRVps2Asset	ValueType, ITrackable, IEquatable<XRVps2Asset>	Describes session-relative data for a VPS asset's origin.
XRVps2AssetSubsystemCinfo	ValueType, IEquatable<XRVps2AssetSubsystemCinfo>	Constructor parameters for the XRVps2AssetSubsystemDescriptor.
XRVps2AssetTrackingData	ValueType	The pose of a VPS asset's origin in the device's AR tracking space.
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.

Enums

Name	Type	Summary
ScanningState	ScanningState	-
Vps2AnchorTrackingStateReason	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	Type of request reported by a XRVps2LocalizationRequestRecord.
Vps2TrackingState	Vps2TrackingState	-

Package NianticSpatial.NSDK.AR.XRSubsystems XRSubsystems

Classes​

Structs​

Enums​

XRSubsystems

Classes

Structs

Enums