Skip to main content
←API Reference ←com.nianticspatial.nsdk

Vps2Config

Configuration structure for the VPS2 session.

Declaration​

class Vps2Config

See also​

  • Vps2Session.configure

Properties​

NameTypeSummary
anchorDistanceGateMetersFloat
Distance gate in meters for anchor candidate filtering when geo-corrected.
Nodes farther than this distance from the device are skipped during anchor localization.
When only GPS is available (no geo-correction), the effective gate is 2x this value.
Use 0 to apply the default value (50m geo-corrected, 100m GPS-only).
Use -1 to disable the distance check entirely.
Default: 0 (uses native default of 50m geo-corrected / 100m GPS-only)
continuousVpsRequestsPerSecondFloat
Number of VPS localization requests per second to send the server while successfully
localized on a VPS map.
Default: 0.2f (native default)
deviceMapLocalizationFramerateInt
Number of times per second to attempt localization on available device maps.
Default: 10 (native default)
enableDeviceMapLocalizationBoolean
If true, localization on device maps is enabled.
Device maps are created by the on-device mapping feature. They do not provide
a georeference.
Default: false (native default)
enableGeolocationSmoothingBoolean
If true, geolocation smoothing is enabled.
Default: true (native default)
enableUniversalLocalizationBoolean
If true, universal localization is enabled.
Universal localization provides geographic positioning that works anywhere without requiring
pre-scanned maps.
Default: false (native default is applied if you leave this unset/zeroed).
enableVpsMapLocalizationBoolean
If true, VPS map localization is enabled.
VPS maps only exist in pre-scanned areas. Your device must be localized on a VPS map in order
for VPS anchors to be placed with high accuracy.
Default: true (native default)
initialVpsRequestsPerSecondFloat
Number of VPS localization requests per second to send the server prior to the first
successful localization on a VPS map.
Default: 1.0f (native default)
maxRequestsInTransitPerTargetInt
Maximum number of concurrent localization requests per target.
Limits how many in-flight cloud localization requests can be active for a single target
simultaneously. Use 0 to apply the default value (2).
Default: 0 (uses native default of 2)
universalLocalizationRequestsPerSecondFloat
Number of requests per second to send to server for universal localization.
Default: 1.0f (native default)
universalLocalizationRequestTimeoutMsInt
Timeout in milliseconds for universal localization requests.
Responses in uncached areas may take 60+ seconds; subsequent requests are typically under
1 second. Use 0 to apply the default value (90000 ms).
Default: 90000 (90 seconds)