Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-kotlin/com.nianticspatial.nsdk.playback.PlaybackBackgroundView.txt — same content, easier to parse than this HTML, with each platform's steps kept separate.

Every page in the current release follows the same pattern, so you can build the URL directly instead of fetching an index: a page at /api/kotlin/<page>/ is at /llms-api-kotlin/<page>.txt.

For every page in this section, read https://www.nianticspatial.com/docs/llms-api-kotlin.txt; for every section of these docs, read https://www.nianticspatial.com/docs/llms.txt.

←API Reference ←com.nianticspatial.nsdk.playback

PlaybackBackgroundView

↳ extends ImageView

Declaration

class PlaybackBackgroundView

Summary

A view that displays the current playback frame image as the background. Place this view behind your 3D/GL surface when in playback mode and call [setPlaybackFrame] whenever a new [PlaybackFrame] is delivered so the recorded camera image is shown. Orientation is corrected so that the image (which may be stored in sensor/landscape layout) is rotated to match the current device orientation using [ImageMath.displayTransform]. Use with [PlaybackSession] and a frame listener: when the session delivers a frame, build [FrameData] for NSDK and call [setPlaybackFrame] to update this view.

Functions

Name	Type	Summary
onSizeChanged	void	-
setPlaybackFrame	void	Updates the background image from the given playback frame. Call on the main thread when [PlaybackSession] delivers a new frame. If [frame] is null or [frame.image] is null, the view is cleared. Applies a display transform so the image orientation matches the current device orientation. Uses frame metadata [screenOrientation] when present, with fallback to resolution-based inference.

Class PlaybackBackgroundView PlaybackBackgroundView

Declaration​

Summary​

Functions​

PlaybackBackgroundView

Declaration

Summary

Functions