Share via

DepthMediaFrameFormat Class

  • Reference

Definition

Namespace:
Windows.Media.Capture.Frames
Edit

Describes the format of a DepthMediaFrame.

public ref class DepthMediaFrameFormat 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 DepthMediaFrameFormat 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 DepthMediaFrameFormat
Public NotInheritable Class DepthMediaFrameFormat
Inheritance
Object Platform::Object IInspectable DepthMediaFrameFormat
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 DepthFormat property of a DepthMediaFrame object.

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

Properties

DepthScaleInMeters

Gets the scale of the depth values in a DepthMediaFrame, in meters.
VideoFormat

Gets the VideoMediaFrameFormat object that describes the non-depth-specific format of a DepthMediaFrame.

Applies to

See also