saveCurrentScan
Declaration
@MainActor func saveCurrentScan(timeout: Double = 10.0, pollingInterval: TimeInterval = 0.1) async throws -> NSDKScanningSession.SaveInfo
Summary
Returns
Information about the saved scan, including it's id and file location.
Throws
CancellationErrorif the Task running this function was cancelled.TimeoutErrorif the function timed out before it could complete execution.NSDKScanningSession.SaveErrorif there was an error specific to the save operation.
Notice
Important: Runs on the main actor, where the session is created and updated.
See also
stopconfigure(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) |
Stops recording and asynchronously saves the recording to the configured path.
Calling this function will stop the active recording, but
stopmust still be calledafterward to completely shut down this session.