Skip to main content
API Reference NSDK

PlaybackDatasetSource

Protocol for loading playback dataset data from various sources....

Declaration

protocol PlaybackDatasetSource

Summary

Protocol for loading playback dataset data from various sources. This protocol abstracts data retrieval, allowing for different implementations such as bundle loading, file system loading, remote loading, or mock data for testing. Implementations are used for on-demand frame loading - the loader is passed to PlaybackDataset which calls these methods when frames are requested.


Methods

NameTypeSummary
infoString
Returns details about the loader configuration.
- Returns: A string describing the loader configuration
loadCaptureJSONData?
Loads the capture JSON data from the data source.
- Returns: The JSON data as Data, or nil if loading fails
loadDepthConfidenceData?
Loads depth confidence data from the data source.
This method is called on-demand when confidence data is requested.
- Parameter confidenceFileName: The filename of the confidence data file (e.g., "confidence_00000000.bin")
- Returns: The confidence data as Data, or nil if loading fails or confidence data is not available
loadDepthDataData?
Loads depth data from the data source.
This method is called on-demand when depth data is requested.
- Parameter depthFileName: The filename of the depth data file (e.g., "depth_00000000.bin")
- Returns: The depth data as Data, or nil if loading fails or depth data is not available
loadImageCGImage?
Loads an image from the data source.
This method is called on-demand when a frame image is requested.
- Parameter imageName: The filename of the image (e.g., "frame_00000000.jpg")
- Returns: The image as a CGImage, or nil if loading fails

Relationships

conformance: BundlePlaybackDatasetLoader
conformance: PlaybackDatasetLoader