> For the complete documentation index, see [llms.txt](https://docs.multiset.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.multiset.ai/native-sdk/ios-swift-native/api-reference.md). # API Reference API reference index for the MultiSet iOS SDK, covering MultiSetConfig, the MultiSetCallback protocol, LocalizationResult, the localization lifecycle, custom AR runtimes and map creation. This section provides detailed API documentation for the MultiSet iOS SDK components. ## Configuration ### [MultiSetConfig](/native-sdk/ios-swift-native/api-reference/multisetconfig.md) 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) and client naming (clientSource) * Map configuration (mapCode, mapSetCode) * Localization mode selection (single-frame, multi-frame) * Matching pipeline selection for single-frame and multi-frame queries (queryMode: VPS-1 or VPS-2) * Localization behavior settings (auto-localize, background localization, relocalization, first fix retries) * 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, restart) * UI feedback options * Image quality settings ## Events and Results ### [MultiSetCallback](/native-sdk/ios-swift-native/api-reference/multisetcallback.md) The protocol your app implements to receive SDK events: authentication, localization, false positives, recovery, run stages, object tracking, and mesh loading. Also documents `FalsePositiveInfo`. ### [LocalizationResult](/native-sdk/ios-swift-native/api-reference/localizationresult.md) The object delivered on a successful localization: computed pose, raw server pose, confidence, and optional geographic data (`GeoCoordinates`, `GeoPose`). Also documents the supporting enums. ## Lifecycle and Runtimes ### [Lifecycle and AR Runtimes](/native-sdk/ios-swift-native/api-reference/lifecycle-and-runtimes.md) How the SDK retries a first fix, refreshes in the background and recovers after a tracking break; how to show a run's progress; threading; and how to drive the SDK from your own `ARView` or a runtime other than ARKit. ### [Map Creation](/native-sdk/ios-swift-native/api-reference/map-creation.md) Scan a space with LiDAR or without it, keep the scan as a draft and upload it to be built into a map, through `MultiSet.shared.mapping`. ## Quick Reference | Component | Description | | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `MultiSetConfig` | Centralized configuration for all SDK behavior | | `MultiSet` | Main SDK singleton for initialization and control (`@MainActor`) | | `MultiSetARView` | SwiftUI view wrapping an ARKit `ARView`, from the `MultiSetAR` folder | | `MultiSetCallback` | Protocol for SDK event callbacks (`@MainActor`) | | `LocalizationResult` | Result object containing localization pose data | | `FalsePositiveInfo` | Details of a localization response the SDK discarded | | `AnchorTrust` | Standing of the pose consistency anchor: `.provisional`, `.corroborated`, `.trusted` | | `LocalizationMode` | Enum: `.singleFrame` or `.multiFrame` | | `QueryMode` | Enum: `.vps1` or `.vps2`, single-frame and multi-frame | | `LocalizationStage` | A run's stage: `.idle`, `.capturing`, `.uploading`, `.awaitingResponse` | | `RecoveryPhase` | Recovery after a tracking break: `.none`, `.waitingForTracking`, `.realigning` | | `TrackingState` | Enum: `.tracking`, `.paused`, `.stopped` | | `GeoCoordinates` | Geographic position returned with a localization result | | `GeoPose` | Full geographic pose, position plus orientation and frame | | `MultiSetFrameSource`, `MultiSetPoseSink`, `MultiSetMeshRenderer`, `MultiSetGeoHintProvider` | Protocols for driving the SDK from a custom AR runtime | | `MultiSetMapping` | Map creation, drafts and uploads (`MultiSet.shared.mapping`) | | `MultiSetMappingSource` | Protocol a scan's frame source implements; `ARMappingSource` is the ARKit one | ## Related * [Sample Views](/native-sdk/ios-swift-native/sample-views.md) * [iOS SDK Overview](/native-sdk/ios-swift-native.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.multiset.ai/native-sdk/ios-swift-native/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.