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.PlaybackDataset.getFrameImageAtIndex.txt — same content, easier to parse than this HTML.
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 .
Function getFrameImageAtIndex getFrameImageAtIndexLoads the frame image at [index] on-demand (and caches it). Returns decoded bitmap, or null if no image.
Declaration
@ Deprecated ( "Will be removed in a future release. Use getPlaybackFrameAtIndex(index).image." , level = DeprecationLevel . WARNING ) fun getFrameImageAtIndex ( index : Int ) : android . graphics . Bitmap ?
Summary
Throws
PlaybackDatasetError.IndexOutOfBounds — if index is invalid.PlaybackDatasetError.ImageLoadFailed — if the image file cannot be loaded.
Parameters
Loads the frame image at
indexon-demand (and caches it). Returns decoded bitmap, or null if no image.