VideoEncodingProperties VideoEncodingProperties VideoEncodingProperties VideoEncodingProperties VideoEncodingProperties Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Describes the encoding properties of a video stream.

public : sealed class VideoEncodingProperties : IMediaEncodingProperties, IVideoEncodingProperties, IVideoEncodingProperties2, IVideoEncodingProperties3, IVideoEncodingProperties4
struct winrt::Windows::Media::MediaProperties::VideoEncodingProperties : IMediaEncodingProperties, IVideoEncodingProperties, IVideoEncodingProperties2, IVideoEncodingProperties3, IVideoEncodingProperties4
public sealed class VideoEncodingProperties : IMediaEncodingProperties, IVideoEncodingProperties, IVideoEncodingProperties2, IVideoEncodingProperties3, IVideoEncodingProperties4
Public NotInheritable Class VideoEncodingProperties Implements IMediaEncodingProperties, IVideoEncodingProperties, IVideoEncodingProperties2, IVideoEncodingProperties3, IVideoEncodingProperties4
var videoEncodingProperties = new videoEncodingProperties();
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Properties that are manually set are ignored for VideoEncodingProperties created from one of the presets encoding profiles: CreateH264 and CreateMpeg2.

The encoding quality Auto is a special preset that fills in the proper settings based on the current camera settings. Settings that are manually modified are ignored. For example, if you create a preset profile using one the static create methods, such as CreateM4a, and specify Auto as the encoding quality, any changes you make to the properties will be overwritten with values based on the current camera settings.

Note

It is possible to create an VideoEncodingProperties that is not supported on a particular device. For example, you may successfully call CreateH264, but if an h264 encoder is not present on the device, attempting to encode video with the properties returned from this method will fail. For a list of the codecs present by default for each device family, see Supported codecs..

For how-to guidance for setting the encoding properties for captured video, see Basic photo, video, and audio capture with MediaCapture.

Constructors

VideoEncodingProperties() VideoEncodingProperties() VideoEncodingProperties() VideoEncodingProperties() VideoEncodingProperties()

Creates a new instance of the VideoEncodingProperties class.

Properties

Bitrate Bitrate Bitrate Bitrate Bitrate

Gets or sets the video bit rate.

FrameRate FrameRate FrameRate FrameRate FrameRate

Gets or sets the video frame rate.

Height Height Height Height Height

Gets or sets the video image height.

PixelAspectRatio PixelAspectRatio PixelAspectRatio PixelAspectRatio PixelAspectRatio

Gets or sets the pixel aspect ratio.

ProfileId ProfileId ProfileId ProfileId ProfileId

Gets or sets the media format profile.

Properties Properties Properties Properties Properties

Gets additional format properties for the video stream.

SphericalVideoFrameFormat SphericalVideoFrameFormat SphericalVideoFrameFormat SphericalVideoFrameFormat SphericalVideoFrameFormat

Gets a value that specifies the spherical video format of a video frame.

StereoscopicVideoPackingMode StereoscopicVideoPackingMode StereoscopicVideoPackingMode StereoscopicVideoPackingMode StereoscopicVideoPackingMode

Gets a value indicating the stereoscopic video packing mode of the video stream.

Subtype Subtype Subtype Subtype Subtype

Gets or sets the subtype of the format.

Type Type Type Type Type

Gets the format type.

Width Width Width Width Width

Gets or sets the video image width.

Methods

Copy() Copy() Copy() Copy() Copy()

Prerelease. Creates a copy of the VideoEncodingProperties object.

CreateH264() CreateH264() CreateH264() CreateH264() CreateH264()

Creates an instance of VideoEncodingProperties for a H.263 video.

CreateHevc() CreateHevc() CreateHevc() CreateHevc() CreateHevc()

Creates an instance of VideoEncodingProperties for High Efficiency Video Coding (HEVC).

CreateMpeg2() CreateMpeg2() CreateMpeg2() CreateMpeg2() CreateMpeg2()

Creates an instance of VideoEncodingProperties for a MPEG-2 video.

CreateUncompressed(String, UInt32, UInt32) CreateUncompressed(String, UInt32, UInt32) CreateUncompressed(String, UInt32, UInt32) CreateUncompressed(String, UInt32, UInt32) CreateUncompressed(String, UInt32, UInt32)

Creates an instance of VideoEncodingProperties for a uncompressed video.

GetFormatUserData(Byte[]) GetFormatUserData(Byte[]) GetFormatUserData(Byte[]) GetFormatUserData(Byte[]) GetFormatUserData(Byte[])

Gets the media format user data.

SetFormatUserData(Byte[]) SetFormatUserData(Byte[]) SetFormatUserData(Byte[]) SetFormatUserData(Byte[]) SetFormatUserData(Byte[])

Sets the media format user data.

See Also