MediaPlayerElement.AreTransportControlsEnabled Property

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Gets or sets a value that determines whether the standard transport controls are enabled.

public:
 property bool AreTransportControlsEnabled { bool get(); void set(bool value); };

bool AreTransportControlsEnabled();

void AreTransportControlsEnabled(bool value);

public bool AreTransportControlsEnabled { get; set; }

var boolean = mediaPlayerElement.areTransportControlsEnabled;
mediaPlayerElement.areTransportControlsEnabled = boolean;

Public Property AreTransportControlsEnabled As Boolean

<MediaPlayerElement AreTransportControlsEnabled="bool"/>

Property Value

Boolean

bool

true if the standard transport controls are enabled; otherwise, false. The default is false.

Remarks

The transport controls are exposed as a MediaTransportControls object that you can access through the MediaPlayerElement.TransportControls property. See MediaTransportControls for more info.

If AreTransportControlsEnabled is true, the standard transport controls are enabled and displayed on the MediaPlayerElement. If AreTransportControlsEnabled is false, the standard transport controls are not enabled and are not displayed.

The transport controls hide themselves after a short period of no user interaction with the MediaPlayerElement. They reappear when the user interacts with the MediaPlayerElement.

If the Width of MediaPlayerElement is not sufficient to display all of the transport controls, a subset of the controls are displayed.

Note

If you disable the MediaPlaybackCommandManager by setting IsEnabled to false, it will break the link between the MediaPlayer the TransportControls provided by the MediaPlayerElement, so the built-in transport controls will no longer automatically control the playback of the player. Instead, you must implement your own controls to control the MediaPlayer.