MediaCaptureInitializationSettings.PreviewMediaDescription Property


Gets or sets the media description for preview video.

 property MediaCaptureVideoProfileMediaDescription ^ PreviewMediaDescription { MediaCaptureVideoProfileMediaDescription ^ get(); void set(MediaCaptureVideoProfileMediaDescription ^ value); };
MediaCaptureVideoProfileMediaDescription PreviewMediaDescription();

void PreviewMediaDescription(MediaCaptureVideoProfileMediaDescription value);
public MediaCaptureVideoProfileMediaDescription PreviewMediaDescription { get; set; }
var mediaCaptureVideoProfileMediaDescription = mediaCaptureInitializationSettings.previewMediaDescription;
mediaCaptureInitializationSettings.previewMediaDescription = mediaCaptureVideoProfileMediaDescription;
Public Property PreviewMediaDescription As MediaCaptureVideoProfileMediaDescription

Property Value


The media description for preview video.

Windows requirements

App capabilities


An instance of MediaCaptureVideoProfileMediaDescription defines a group of capture settings that are supported by a video profile. For example, one MediaCaptureVideoProfileMediaDescription object could represent settings for recording 720p video at 30 fps with HDR video and another could represent settings for recording 1080p video at 30 fps without HDR video support. A MediaCaptureVideoProfile object contains separate lists of supported media descriptions for photo capture, preview, and video recording that are supported for that profile. For more information on video profiles, see MediaCaptureVideoProfile.

The way the system uses the PreviewMediaDescription property depends on the value of the VideoProfile property.

  • If you set VideoProfile to a non-null value and you set PreviewMediaDescription to a value in the video profile's SupportedPreviewMediaDescription list, the system will use your provided media description and will provide optimization hints to the driver based on the profile you specify.
  • If you set VideoProfile to a non-null value and the value of PreviewMediaDescription is not set, then the system will use the first entry in the video profile's SupportedPreviewMediaDescription list as the media description.
  • If the value of VideoProfile is not set at all then the system ignores the value of PreviewMediaDescription and reverts to the legacy behavior before these APIs were introduced.

Applies to

See also