MusicDisplayProperties Class

Reference

Definition

Namespace:: Windows.Media

Important

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

Edit

Provides properties for music information that is displayed by the SystemMediaTransportControlsDisplayUpdater class.

public ref class MusicDisplayProperties 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 MusicDisplayProperties 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 MusicDisplayProperties

Public NotInheritable Class MusicDisplayProperties

Inheritance: Object Platform::Object IInspectable MusicDisplayProperties

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 MusicDisplayProperties 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 MusicDisplayProperties by using the SystemMediaTransportControlsDisplayUpdater class. For how-to guidance on manually controlling the SMTC, see Manual control of the System Media Transport Controls.

Version history

Windows version	SDK version	Value added
1607	14393	AlbumTrackCount

Properties

AlbumArtist	Gets or sets the name of the album artist.
AlbumTitle	Gets or sets the album title.
AlbumTrackCount	Gets or sets the album track count.
Artist	Gets or set the name of the song artist.
Genres	Gets a modifiable list of strings representing genre names.
Title	Gets or set the title of the song.
TrackNumber	Gets or sets the track number.

Applies to

Dela via