←API Reference ←SwiftyNsdk ←NsdkScanningSession

exportArchive

Exports the scan data as an archive file....

---

Declaration

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

Summary

Exports the scan data as an archive file.
This method processes the saved scan data and exports it to a standard archive format
that can be used with external 3D processing tools or Niantic's VPS map.
- Note: This function is blocking and may take a while to execute. See
NsdkRecordingExporter for a non-blocking alternative.
- Precondition: Argument metadata must be a valid JSON object string.
- Parameter metadata: Metadata dictionary to include with the export. Can be left empty.
- 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: The path of the archive file, 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.

---