VideoDisplayProperties Class

  • Reference

Definition

Namespace:
Windows.Media
Edit

Provides properties for video information that is displayed by SystemMediaTransportControlsDisplayUpdater class.

public ref class VideoDisplayProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class VideoDisplayProperties final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class VideoDisplayProperties
Public NotInheritable Class VideoDisplayProperties
Inheritance
Object Platform::Object IInspectable VideoDisplayProperties
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Starting with Windows 10, version 1607, UWP apps that use the MediaPlayer class or AudioGraph class to play media are automatically integrated with the System Media Transport Controls by default. When using automatic integration, you can get an instance of the VideoDisplayProperties class using the MediaPlaybackItem class. Call GetDisplayProperties to get an instance of the MediaItemDisplayProperties class. Update the object with the values you want to be displayed for the item in the SMTC and then call ApplyDisplayProperties to commit the changes. For how-to guidance on using the SMTC from your app, see Integrate with the SystemMediaTransportControls.

When manually controlling the SMTC, get an instance of VideoDisplayProperties by using the SystemMediaTransportControlsDisplayUpdater class. For how-to guidance on manually controlling the SMTC, see Manual control of the System Media Transport Controls.

Properties

Genres

Gets a modifiable list of strings representing genre names.
Subtitle

Gets or sets the subtitle of the video.
Title

Gets or sets the title of the video.

Applies to

See also