API Reference
This section provides detailed API documentation for the MultiSet iOS SDK components.
Configuration
MultiSetConfig
A struct that provides centralized configuration for the MultiSet SDK. Controls credentials, the API environment, localization behavior, object tracking settings, GPS hints, and UI feedback.
Key Features:
Authentication credentials (clientId, clientSecret)
API environment selection (baseURL)
Map configuration (mapCode, mapSetCode)
Localization mode selection (single-frame, multi-frame)
Matching pipeline selection for single-frame queries (queryMode: VPS-1 or VPS-2)
Localization behavior settings (auto-localize, background localization, relocalization)
Multi-frame capture configuration
Confidence thresholds
False-positive detection through the pose consistency check
GPS hint integration
Localization hints to narrow Map / MapSet search (hintMapCodes, hintPosition, hintRadius)
Runtime configuration updates, changing Map / MapSet localization settings and applying them before the next query via
MultiSet.shared.updateConfig(_:)Object tracking settings (objectCodes, auto-tracking, background tracking)
UI feedback options
Image quality settings
Events and Results
MultiSetCallback
The protocol your app implements to receive SDK events: authentication, localization, false positives, object tracking, and mesh loading. Also documents FalsePositiveInfo.
LocalizationResult
The object delivered on a successful localization: computed pose, raw server pose, confidence, and optional geographic data (GeoCoordinates, GeoPose).
Quick Reference
MultiSetConfig
Centralized configuration for all SDK behavior
MultiSet
Main SDK singleton for initialization and control
MultiSetARView
SwiftUI view wrapping ARKit ARView
MultiSetCallback
Protocol for SDK event callbacks
LocalizationResult
Result object containing localization pose data
FalsePositiveInfo
Details of a localization response the SDK discarded
LocalizationMode
Enum: .singleFrame or .multiFrame
QueryMode
Enum: .vps1 or .vps2, single-frame only
TrackingState
Enum: .tracking, .paused, .stopped
GeoCoordinates
Geographic position returned with a localization result
GeoPose
Full geographic pose, position plus orientation and frame
Related
Last updated
Was this helpful?