Skip to main content
←API Reference ←com.nianticspatial.nsdk.playback ←PlaybackCacheSession

playbackFileInfo


Declaration​

suspend fun playbackFileInfo(scanId: String): PlaybackFileInfo

Summary​

Looks up the recording open would play for a scan: its frame count, size and duration as
the 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.

Throws​

  • PlaybackOpenException — if the lookup fails, with PlaybackOpenError.NOT_AUTHENTICATED, PlaybackOpenError.ACCESS_DENIED, PlaybackOpenError.NOT_FOUND, PlaybackOpenError.NO_PLAYBACK_FILE, PlaybackOpenError.NOT_READY, PlaybackOpenError.NETWORK, or PlaybackOpenError.SESSION_ENDED once this session ends.
  • com.nianticspatial.nsdk.NsdkInvalidArgumentStatusException — if scanId is malformed.

Parameters​

NameTypeSummary
scanIdString
The portal scan ID.