mpris2.playlists module

From mprisV2.2 documentation

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

class mpris2.playlists.Playlists(*args, **kw)

Bases: mpris2.interfaces.Interfaces

Provides access to the media player’s playlists.

Since D-Bus does not provide an easy way to check for what interfaces are exported on an object, clients should attempt to get one of the properties on this interface to see if it is implemented.

ActivatePlaylist

Parameters:

• PlaylistId - o

  The id of the playlist to activate.

Starts playing the given playlist.

Note that this must be implemented. If the media player does not allow clients to change the playlist, it should not implement this interface at all.

It is up to the media player whether this completely replaces the current tracklist, or whether it is merely inserted into the tracklist and the first track starts. For example, if the media player is operating in a ‘jukebox’ mode, it may just append the playlist to the list of upcoming tracks, and skip to the first track in the playlist.

ActivePlaylist

Returns

Read only

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

The currently-active playlist.

If there is no currently-active playlist, the structure’s Valid field will be false, and the Playlist details are undefined.

Note that this may not have a value even after ActivatePlaylist is called with a valid playlist id as ActivatePlaylist implementations have the option of simply inserting the contents of the playlist into the current tracklist.

GetPlaylists

Parameters:

• Index - u

  The index of the first playlist to be fetched (according to the ordering).

• MaxCount - u

  The maximum number of playlists to fetch.

• Order - s (Playlist_Ordering)

  The ordering that should be used.

• ReverseOrder - b

  Whether the order should be reversed.

Returns

• Playlists - a(oss) (Playlist_List)

  A list of (at most MaxCount) playlists.

Gets a set of playlists.

Orderings

Returns

Read only

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

The avaislable orderings. At least one must be offered.

PlaylistChanged

Parameters

• Playlist - (oss) (Playlist)

  The playlist whose details have changed.

Indicates that the name or icon for a playlist has changed.

Note that, for this signal to operate correctly, the id of the playlist must not change when the name changes.

PlaylistCount

Returns

Read only

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

The number of playlists available.