DepthMediaFrame Class

  • Reference

Definition

Namespace:
Windows.Media.Capture.Frames
Edit

Represents a VideoMediaFrame that contains depth video data.

public ref class DepthMediaFrame sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DepthMediaFrame final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DepthMediaFrame
Public NotInheritable Class DepthMediaFrame
Inheritance
Object Platform::Object IInspectable DepthMediaFrame
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

Get an instance of this class by accessing the DepthMediaFrame property of the VideoMediaFrame class.

For how-to guidance on using MediaFrameSource to capture frames, see Process media frames with MediaFrameReader.

Version history

Windows version SDK version Value added
1703 15063 MaxReliableDepth
1703 15063 MinReliableDepth

Properties

DepthFormat

Gets an object that describes the format of the depth data in the DepthMediaFrame.
FrameReference

Gets the MediaFrameReference wrapper object associated with the DepthMediaFrame, which provides access to format information and other properties of the media frame.
MaxReliableDepth

Gets a value that specifies the maximum reliable depth value for the camera that captured the depth frame.
MinReliableDepth

Gets a value that specifies the minimum reliable depth value for the camera that captured the depth frame.
VideoMediaFrame

Gets the VideoMediaFrame associated with the DepthMediaFrame.

Methods

TryCreateCoordinateMapper(CameraIntrinsics, SpatialCoordinateSystem)

Attempts to create a DepthCorrelatedCoordinateMapper for the DepthMediaFrame. This object provides methods for mapping pixel coordinates from a MediaFrameSource camera to the coordinate system of a different MediaFrameSource or to 3D space.

Applies to

See also