playbackFileInfo
Declaration
suspend fun playbackFileInfo(scanId: String): PlaybackFileInfo
Summary
Throws
PlaybackOpenException— if the lookup fails, withPlaybackOpenError.NOT_AUTHENTICATED,PlaybackOpenError.ACCESS_DENIED,PlaybackOpenError.NOT_FOUND,PlaybackOpenError.NO_PLAYBACK_FILE,PlaybackOpenError.NOT_READY,PlaybackOpenError.NETWORK, orPlaybackOpenError.SESSION_ENDEDonce this session ends.com.nianticspatial.nsdk.NsdkInvalidArgumentStatusException— ifscanIdis malformed.
Parameters
| Name | Type | Summary |
|---|---|---|
| scanId | String | The portal scan ID. |
Looks up the recording
openwould play for a scan: its frame count, size and duration asthe portal lists them, before anything is downloaded.
Lists the scan's files on the portal and downloads nothing, so it needs the network and an
authorized NSDK session even for a cached scan; keep the result to show it offline.
Describes only the first chunk of a chunked recording, the one that plays. Any number may
run at once, so a list can look up each row as it appears. Cancelling the calling coroutine
takes effect once the lookup ends.