Skip to main content
Version: 21 Aug 2024

Frame

A structure to encapsulate per plane info for each camera frame.

Public Methods

override string ToString

public override string ToString()

Public Attributes

CameraId

Camera Identifier specifies which camera is associated with this frame.


public readonly CameraId CameraId;

TypeDescription
readonly CameraIdEnumeration of all the available world camera sensors.

CameraIntrinsics

Camera intrinsics.


public readonly CameraIntrinsics CameraIntrinsics;

TypeDescription
readonly CameraIntrinsicsWorld camera intrinsic parameters.

CameraPose

World camera pose in the world co-ordinate system.


public readonly Pose CameraPose;


FrameBuffer

Frame buffer data.


public readonly Buffer FrameBuffer;

TypeDescription
readonly BufferA structure to encapsulate per plane info for each camera frame.

FrameNumber

A 64bit integer to index the frame number associated with this frame.


public readonly long FrameNumber;


FrameType

Maps to the world camera mode used for capturing the camera frames.


public readonly Type FrameType;

TypeDescription
readonly TypeEnumeration of camera mode used when capturing a frame.

TimeStamp

Frame timestamp specifies the time at which the frame was captured.


public readonly MLTime TimeStamp;

TypeDescription
readonly MLTimeRepresents an ML API wide timestamp in nanoseconds that is not guaranteed to be synced with any system time. If OpenXR is used, MLTime is synonymous with the XrTime type.

Public Enums

Type

Enumeration of camera mode used when capturing a frame.

EnumeratorValueDescription
UnkownNone.
LowExposureFrame captured using #MLWorldCameraMode_LowExposure mode.
NormalExposureFrame captured using #MLWorldCameraMode_NormalEposure mode.