Interface MediaPlayer2

Interface Index (Compact) | Summary | Methods | Properties

Methods

Raise () → nothing
Quit () → nothing

Properties

CanQuit b Read only
CanRaise b Read only
HasTrackList b Read only
Identity s Read only
DesktopEntry s Read only
SupportedUriSchemes as Read only
SupportedMimeTypes as Read only

Methods

(Permalink)

Raise () → nothing

Brings the media player's user interface to the front using any appropriate mechanism available.

The media player may be unable to control how its user interface is displayed, or it may not have a graphical user interface at all. In this case, the CanRaise property is false and this method does nothing.

(Permalink)

Quit () → nothing

Causes the media player to stop running.

The media player may refuse to allow clients to shut it down. In this case, the CanQuit property is false and this method does nothing.

Note: Media players which can be D-Bus activated, or for which there is no sensibly easy way to terminate a running instance (via the main interface or a notification area icon for example) should allow clients to use this method. Otherwise, it should not be needed.

If the media player does not have a UI, this should be implemented

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

CanQuit — b

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

If false, calling Quit will have no effect, and may raise a NotSupported error. If true, calling Quit will cause the media application to attempt to quit (although it may still be prevented from quitting by the user, for example).

(Permalink)

CanRaise — b

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

If false, calling Raise will have no effect, and may raise a NotSupported error. If true, calling Raise will cause the media application to attempt to bring its user interface to the front, although it may be prevented from doing so (by the window manager, for example).

(Permalink)

HasTrackList — b

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

Indicates whether the /org/mpris/MediaPlayer2 object implements the org.mpris.MediaPlayer2.TrackList interface.

(Permalink)

Identity — s

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

A friendly name to identify the media player to users.

This should usually match the name found in .desktop files

(eg: "VLC media player").

(Permalink)

DesktopEntry — s

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The basename of an installed .desktop file which complies with the Desktop entry specification, with the ".desktop" extension stripped.

Example: The desktop entry file is "/usr/share/applications/vlc.desktop", and this property contains "vlc"

This property is optional. Clients should handle its absence gracefully

(Permalink)

SupportedUriSchemes — as

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The URI schemes supported by the media player.

This can be viewed as protocols supported by the player in almost all cases. Almost every media player will include support for the "file" scheme. Other common schemes are "http" and "rtsp".

Note that URI schemes should be lower-case.

Rationale:

This is important for clients to know when using the editing capabilities of the Playlist interface, for example.

(Permalink)

SupportedMimeTypes — as

Read only
When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.

The mime-types supported by the media player.

Mime-types should be in the standard format (eg: audio/mpeg or application/ogg).

Rationale:

This is important for clients to know when using the editing capabilities of the Playlist interface, for example.