VideoMediaFrameFormat VideoMediaFrameFormat VideoMediaFrameFormat VideoMediaFrameFormat Class

Definition

Describes the image format of a VideoMediaFrame.

public : sealed class VideoMediaFrameFormat : IVideoMediaFrameFormatpublic sealed class VideoMediaFrameFormat : IVideoMediaFrameFormatPublic NotInheritable Class VideoMediaFrameFormat Implements IVideoMediaFrameFormat// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Get an instance of this class by accessing the MediaFrameFormat.VideoFormat, VideoMediaFrame.VideoFormat, or DepthMediaFrame.VideoFormat property.

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

Properties

DepthFormat DepthFormat DepthFormat DepthFormat

Gets an object that describes the format of the depth data in a video media frame, if the frame contains depth data.

public : DepthMediaFrameFormat DepthFormat { get; }public DepthMediaFrameFormat DepthFormat { get; }Public ReadOnly Property DepthFormat As DepthMediaFrameFormat// You can use this property in JavaScript.
Value
DepthMediaFrameFormat DepthMediaFrameFormat DepthMediaFrameFormat DepthMediaFrameFormat

An object that describes the format of the depth data in a video media frame.

Remarks

If the video media frame does not contain depth data, this property is null.

Height Height Height Height

Gets the height of the video media frame, in pixels.

public : unsigned int Height { get; }public uint Height { get; }Public ReadOnly Property Height As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The height of the video media frame, in pixels.

MediaFrameFormat MediaFrameFormat MediaFrameFormat MediaFrameFormat

Gets an object that provides information about the format of the media frame that is not specific to video frames.

public : MediaFrameFormat MediaFrameFormat { get; }public MediaFrameFormat MediaFrameFormat { get; }Public ReadOnly Property MediaFrameFormat As MediaFrameFormat// You can use this property in JavaScript.
Value
MediaFrameFormat MediaFrameFormat MediaFrameFormat MediaFrameFormat

An object that provides information about the format of the media frame.

Width Width Width Width

Gets the width of the video media frame, in pixels.

public : unsigned int Width { get; }public uint Width { get; }Public ReadOnly Property Width As uint// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The width of the video media frame, in pixels.

See Also