The backend API is the interface that must be implemented when you create a backend. If you are working on a frontend and need to access the backend, see the Core API.
Actor proxy to an instance of mopidy.audio.Audio.
Should be passed to the backend constructor as the kwarg audio, which will then set this field.
The library provider. An instance of BaseLibraryProvider, or None if the backend doesn’t provide a library.
The playback provider. An instance of BasePlaybackProvider, or None if the backend doesn’t provide playback.
The playlists provider. An instance of BasePlaylistsProvider, or class:None if the backend doesn’t provide playlists.
List of URI schemes this backend can handle.
Parameters: |
|
---|
Swith to provided track.
MAY be reimplemented by subclass.
Parameters: | track (mopidy.models.Track) – the track to play |
---|---|
Return type: | True if successful, else False |
Get the current time position in milliseconds.
MAY be reimplemented by subclass.
Return type: | int |
---|
Pause playback.
MAY be reimplemented by subclass.
Return type: | True if successful, else False |
---|
Play given track.
MAY be reimplemented by subclass.
Parameters: | track (mopidy.models.Track) – the track to play |
---|---|
Return type: | True if successful, else False |
Resume playback at the same time position playback was paused.
MAY be reimplemented by subclass.
Return type: | True if successful, else False |
---|
Parameters: | backend (mopidy.backends.base.Backend) – backend the controller is a part of |
---|
See mopidy.core.PlaylistsController.create().
MUST be implemented by subclass.
See mopidy.core.PlaylistsController.delete().
MUST be implemented by subclass.
See mopidy.core.PlaylistsController.lookup().
MUST be implemented by subclass.
Currently available playlists.
Read/write. List of mopidy.models.Playlist.
See mopidy.core.PlaylistsController.refresh().
MUST be implemented by subclass.
See mopidy.core.PlaylistsController.save().
MUST be implemented by subclass.
Parameters: | backend (mopidy.backends.base.Backend) – backend the controller is a part of |
---|
See mopidy.core.LibraryController.find_exact().
MAY be implemented by subclass.
See mopidy.core.LibraryController.lookup().
MUST be implemented by subclass.
See mopidy.core.LibraryController.refresh().
MAY be implemented by subclass.
See mopidy.core.LibraryController.search().
MAY be implemented by subclass.
Marker interface for recipients of events sent by the backend actors.
Any Pykka actor that mixes in this class will receive calls to the methods defined here when the corresponding events happen in the core actor. This interface is used both for looking up what actors to notify of the events, and for providing default implementations for those listeners that are not interested in all events.
Normally, only the Core actor should mix in this class.
Called on all events.
MAY be implemented by actor. By default, this method forwards the event to the specific event methods.
Parameters: |
|
---|