←API Reference ←com.nianticspatial.nsdk

AnchorTrackingStateReason

---

Declaration

enum class AnchorTrackingStateReason

Summary

Provides additional context about why an anchor is in a particular tracking state. When an anchor is not tracked or has limited tracking, this enum provides specific reasons that can help developers understand and respond to tracking issues.

Overview

Tracking state reasons help diagnose why tracking may be failing or limited, enabling applications to provide appropriate user feedback or take corrective actions.

Example

val update = vpsSession.getAnchorUpdate(anchorId)
when (update.trackingStateReason) {
AnchorTrackingStateReason.INITIALIZING ->
println("Anchor is still initializing - tracking will improve")
AnchorTrackingStateReason.PERMISSION_DENIED ->
println("Tracking failed due to permission issues")
AnchorTrackingStateReason.FATAL_NETWORK_ERROR ->
println("Network error preventing tracking")
else ->
println("Other tracking issue: ${update.trackingStateReason}")
}

---

Properties

Name	Type	Summary
value	Int	-

---

Cases

Name	Type	Summary
FATAL_NETWORK_ERROR	FATAL_NETWORK_ERROR	A fatal network error prevented tracking. This reason indicates that network connectivity issues are preventing the VPS system from functioning properly.
INITIALIZING	INITIALIZING	The anchor is currently initializing and tracking will improve. This reason indicates that the system is still processing the anchor's visual features and tracking quality should improve over time.
INTERNAL_ERROR	INTERNAL_ERROR	An internal error occurred within the tracking system. This reason indicates a system-level error that prevented normal tracking. The application should check the VPS feature status for more details.
NONE	NONE	No specific reason for the current tracking state. This is the default state when tracking is working normally or when no specific reason has been identified for tracking issues.
NO_VISUAL_LOCALIZATION	NO_VISUAL_LOCALIZATION	The device has not localized to a VPS location. This reason indicates that the device has not yet successfully localized to a VPS location, so anchor position accuracy is limited.
PERMISSION_DENIED	PERMISSION_DENIED	Tracking failed due to insufficient permissions. This reason indicates that the anchor target requested is not accessible by the current authenticated user. Check that the API key or authentication token has the necessary permissions and organization access.
REMOVED	REMOVED	The anchor has been explicitly removed from tracking. This reason indicates that the anchor was removed via removeAnchor and is no longer being tracked by the system.

---