MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription Class

Definition

Represents a description of media that is supported by a video profile.

public : sealed class MediaCaptureVideoProfileMediaDescription : IMediaCaptureVideoProfileMediaDescriptionpublic sealed class MediaCaptureVideoProfileMediaDescription : IMediaCaptureVideoProfileMediaDescriptionPublic NotInheritable Class MediaCaptureVideoProfileMediaDescription Implements IMediaCaptureVideoProfileMediaDescription// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

An instance of MediaCaptureVideoProfileMediaDescription defines a group of capture settings that are supported by a video profile. For example, a single video profile may support recording 720p video at 30 fps with HDR video support and also support recording 1080p video at 30 fps without HDR video support. In this case, each of these would be represented by a MediaCaptureVideoProfileMediaDescription object in the SupportedRecordMediaDescription list of the video profile. Each profile contains separate lists of media descriptions for photo capture, preview, and video recording. For more information on video profiles, see MediaCaptureVideoProfile.

You configure the capture device to use a particular MediaCaptureVideoProfileMediaDescription by using the MediaCaptureInitializationSettings object. It is important that the video profile media description values you use when configuring the device are compatible with the other initialization settings. For more information on how to correctly use media profile descriptions in the MediaCaptureInitializationSettings, see MediaCaptureInitializationSettings.PhotoMediaDescription, MediaCaptureInitializationSettings.PreviewMediaDescription, and MediaCaptureInitializationSettings.RecordMediaDescription.

For how-to guidance for working with video profiles, see Discover and select camera capabilities with camera profiles.

Properties

FrameRate FrameRate FrameRate FrameRate

Gets the frame rate of the media description.

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

The frame rate of the media description.

Height Height Height Height

Gets the height of the media description.

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 media description.

IsHdrVideoSupported IsHdrVideoSupported IsHdrVideoSupported IsHdrVideoSupported

Gets a value indicating if the media description includes HDR video support.

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

True if HDR video is supported; otherwise, false.

IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported

Gets a value indicating if the media description includes variable photo sequence support.

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

True if variable photo sequence is supported; otherwise, false.

Width Width Width Width

Gets the width of the media description.

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 media description.

See Also