←API Reference ←SwiftyNsdk ←NsdkScanningSession

exportSplitArchive

Exports the scan data as multiple archive files....

---

Declaration

func exportSplitArchive(metadata: [String : Any]? = nil, maxFramesPerArchive: Int, exportAsVideo: Bool = true) throws -> [String]?

Summary

Exports the scan data as multiple archive files.
This method processes the saved scan data and exports it to multiple archive files
based on the maxFramesPerArchive parameter. Each archive will contain at most
maxFramesPerArchive frames.
- Note: This function is blocking and may take a while to execute.
- Precondition: Argument metadata must be a valid JSON object string.
- Parameter metadata: Metadata dictionary to include with the export. Can be left empty.
- Parameter maxFramesPerArchive: Maximum number of frames per archive file.
- Parameter exportAsVideo: If true, the RGB frames in the scan will be exported as an
.mp4 video. If false, they will be individual image files.
- Returns: An array of paths to the archive files, if the export was successful, nil if otherwise.
Export failure indicates something was wrong with the saved scan.
- Throws:
- NsdkError.invalidOperation if the scanning session did not have a saved scan to export.

---