Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-swift/NSDK.NSDKScanningSession.method-saveCurrentScan.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/swift/<page>/ is at /llms-api-swift/<page>.txt.

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

←API Reference ←NSDK ←NSDKScanningSession

saveCurrentScan

Declaration

func saveCurrentScan(timeout: Double = 10.0, pollingInterval: TimeInterval = 0.1) async throws -> NSDKScanningSession.SaveInfo

Summary

Stops recording and asynchronously saves the recording to the configured path.
Calling this function will stop the active recording, but stop must still be called
afterward to completely shut down this session.

Returns

Information about the saved scan, including it's id and file location.

Throws

- CancellationError if the Task running this function was cancelled. - TimeoutError if the function timed out before it could complete execution. - NSDKScanningSession.SaveError if there was an error specific to the save operation. - SeeAlso: - stop - configure(with:)

Parameters

Name	Type	Summary
timeout	Double	The maximum duration in seconds to wait for the save operation (default is 10 seconds).
pollingInterval	TimeInterval	The interval in seconds to wait between progress checks (default is 0.1 seconds)

Method saveCurrentScan saveCurrentScan

Declaration​

Summary​

Returns​

Throws​

Parameters​