MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription MediaCaptureVideoProfileMediaDescription Class

Definition

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

public : sealed class MediaCaptureVideoProfileMediaDescription
struct winrt::Windows::Media::Capture::MediaCaptureVideoProfileMediaDescription
public sealed class MediaCaptureVideoProfileMediaDescription
Public NotInheritable Class MediaCaptureVideoProfileMediaDescription
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
backgroundMediaRecording

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.

Version history

Windows version SDK version Value added
1803 17134 Properties
1803 17134 Subtype

Properties

FrameRate FrameRate FrameRate FrameRate FrameRate

Gets the frame rate of the media description.

Height Height Height Height Height

Gets the height of the media description.

IsHdrVideoSupported IsHdrVideoSupported IsHdrVideoSupported IsHdrVideoSupported IsHdrVideoSupported

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

IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported IsVariablePhotoSequenceSupported

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

Properties Properties Properties Properties Properties

Gets a read-only map of custom attributes provided by the capture device manufacturer.

Subtype Subtype Subtype Subtype Subtype

Gets a string containing the standard name for the media encoding subtype supported by the media profile, such as "Aac", "Jpeg", or "Hevc".

Width Width Width Width Width

Gets the width of the media description.

See also