Skip to main content
API Reference NSDK

NSDKSessionDataSource

Provides synchronous, pull-based access to the latest available sensor data...

Declaration

protocol NSDKSessionDataSource : AnyObject

Summary

Provides synchronous, pull-based access to the latest available sensor data required by NSDKSession. All methods must be non-blocking and thread-safe. Returned values represent the most recent samples already captured by the underlying services.


Properties

NameTypeSummary
var isReadyBool
Indicates whether the data source is currently able to provide
meaningful sensor data.

Methods

NameTypeSummary
latestCameraSample(image: CVPixelBuffer, intrinsics: NSDKCameraIntrinsics, pose: NSDKCameraExtrinsics, orientation: NSDKScreenOrientation, timestamp: UInt64)?
Returns the most recent camera sample, if available.
- Returns: A tuple containing:
- image: A retained CVPixelBuffer representing the captured image.
- intrinsics: Camera intrinsic parameters for the image.
- pose: The pose (extrinsics) of the camera associated with the image.
- orientation: The device orientation of the camera associated with the image.
- timestamp: Camera timestamp in milliseconds.
latestCompassSampleNSDKFrameData.CompassData?
Returns the most recent compass (heading) sample, if available.
latestDepthMapSample(image: CVPixelBuffer, confidence: CVPixelBuffer?, intrinsics: NSDKCameraIntrinsics, pose: NSDKCameraExtrinsics, orientation: NSDKScreenOrientation, timestamp: UInt64)?
Returns the most recent platform depth sample, if available.
- Returns: A tuple containing:
- image: A retained CVPixelBuffer representing the captured image.
- confidence: A pixel buffer containing the confidence level for each depth value in the image.
- intrinsics: Camera intrinsic parameters for the image.
- pose: The pose (extrinsics) of the camera associated with the image.
- orientation: The device orientation of the camera associated with the image.
- timestamp: Camera timestamp in milliseconds.
latestGpsSampleNSDKFrameData.GpsData?
Returns the most recent GPS sample, if available.
latestTrackingStateSampleNsdkTrackingState
Returns the most recent VIO tracking state report

Relationships

conformance: PlaybackSessionDataSource
conformance: DefaultSessionDataSource