MediaFrameFormat Class

  • Reference

Definition

Namespace:
Windows.Media.Capture.Frames
Edit

Describes the format of a media frame obtained from a MediaFrameSource and represented by a MediaFrameReference.

public ref class MediaFrameFormat 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 MediaFrameFormat 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 MediaFrameFormat
Public NotInheritable Class MediaFrameFormat
Inheritance
Object Platform::Object IInspectable MediaFrameFormat
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

The MediaFrameSource class uses this object to specify the current format of the media frames it generates. Get the current format of a media frame source by accessing the CurrentFormat property. Set the current format of a media frame source by calling SetFormatAsync.

Get the format of a media frame represented by a MediaFrameReference by accessing the Format property.

Get the format of a video frame represented by a VideoMediaFrame by accessing the VideoFormat property and then using the returned object's MediaFrameFormat property.

Version history

Windows version SDK version Value added
1803 17134 AudioEncodingProperties

Properties

AudioEncodingProperties

Gets an AudioEncodingProperties object that provides information about the audio data in an audio frame. This includes information like the bitrate, sample rate, and channel count of the audio data.
FrameRate

Gets the frame rate of the media frame.
MajorType

Gets a string identifying the major type of a media frame.
Properties

Gets a map of properties for the frame format.
Subtype

Gets a string identifying the subtype of a media frame.
VideoFormat

Gets an object describing the image format of a video media frame.

Applies to