mpris2.mediaplayer2 module¶

From mprisV2.2 documentation

http://specifications.freedesktop.org/mpris-spec/latest/Media_Player.html

class mpris2.mediaplayer2.MediaPlayer2(*args, **kw)[source]¶

Bases: mpris2.interfaces.Interfaces

Interface for MediaPlayer2 (org.mpris.MediaPlayer2)

CanQuit¶

Returns

Read only: Inject attrs from decorator at new object then return obje

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).

CanRaise¶

Returns

Read only: 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).

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

CanSetFullscreen¶

Returns

Read only: If false, attempting to set Fullscreen will have no effect, and may raise an error. If true, attempting to set Fullscreen will not raise an error, and (if it is different from the current value) will cause the media player to attempt to enter or exit fullscreen mode.

This property is optional. Clients should handle its absence gracefully.

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

Added in 2.2.

..note::: Note that the media player may be unable to fulfil the request. In this case, the value will not change. If the media player knows in advance that it will not be able to fulfil the request, however, this property should be false.

DesktopEntry¶

Returns

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

Fullscreen¶

Returns

Read Write: Whether the media player is occupying the fullscreen.

This property is optional. Clients should handle its absence gracefully.

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

This is typically used for videos. A value of true indicates that the media player is taking up the full screen.

Media center software may well have this value fixed to true

If CanSetFullscreen is true, clients may set this property to true to tell the media player to enter fullscreen mode, or to false to return to windowed mode.

If CanSetFullscreen is false, then attempting to set this property should have no effect, and may raise an error. However, even if it is true, the media player may still be unable to fulfil the request, in which case attempting to set this property will have no effect (but should not raise an error).

Added in 2.2.

HasTrackList¶

Returns

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.

Identity¶

Returns

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).

PROPERTIES_CAN_QUIT = 'CanQuit'¶

PROPERTIES_CAN_RAISE = 'Identity'¶

PROPERTIES_DESKTOP_ENTRY = 'DesktopEntry'¶

PROPERTIES_HAS_TRACK_LIST = 'HasTrackList'¶

PROPERTIES_IDENTITY = 'Identity'¶

PROPERTIES_SUPPORTED_MINE_TYPES = 'SupportedMimeTypes'¶

PROPERTIES_SUPPORTED_URI_SCHEMES = 'SupportedUriSchemes'¶

PropertiesChanged¶

Parameters:

args - list

unnamed parameters passed by dbus signal
kw - dict

named parameters passed by dbus signal

Every time that some property change, signal will be called

Quit¶

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

Raise¶

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 Identity property is false and this method does nothing.

SIGNALS_PROPERTIES_CHANGED = 'PropertiesChanged'¶

SupportedMimeTypes¶

Returns

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).

Note

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

SupportedUriSchemes¶

Returns

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.

Note

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