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

PlaybackFrame


Declaration​

data class PlaybackFrame

Summary​

One frame of playback: recorded data, camera representation, optional image and depth. Created when a frame is loaded (e.g. by [PlaybackSession]). Use [camera] for pose/intrinsics and [frameMetadata] for the frame's recorded data.


Constructors​

constructor(metadata: FrameMetadata, camera: PlaybackCamera, image: Bitmap? = null, depthData: ByteArray? = null, depthConfidence: ByteArray? = null, compassTimestampBase: ClockBase = ClockBase.EPOCH, frameMetadata: PlaybackFrameMetadata = metadata.toPlaybackFrameMetadata(camera, depthData != null, compassTimestampBase))

Parameters​

NameTypeSummary
metadataFrameMetadata
-
cameraPlaybackCamera
-
imageBitmap?
-
depthDataByteArray?
-
depthConfidenceByteArray?
-
compassTimestampBaseClockBase
-
frameMetadataPlaybackFrameMetadata
-

Properties​

NameTypeSummary
cameraPlaybackCamera
Camera representation for this frame (transform, intrinsics, [PlaybackCamera.toArCorePose]).
compassTimestampBaseClockBase
Clock the dataset's compass timestamps are on (dataset-level; see [PlaybackDataset.compassTimestampBase]).
depthConfidenceByteArray?
Per-pixel depth confidence (UInt8) when available; null otherwise.
depthDataByteArray?
Depth buffer (Float32, meters) for this frame if available; null otherwise.
frameMetadataPlaybackFrameMetadata
Recorded data for this frame, without its buffers.
imageBitmap?
RGB camera image for this frame (e.g. for background display); null if not loaded.
metadataFrameMetadata
Frame metadata from the dataset (pose4x4, intrinsics, resolution, tracking, orientation, location, etc.).

Functions​

NameTypeSummary
fromPlaybackFrame
Builds a [PlaybackFrame] from metadata and optional image/depth. [camera] is created from metadata.