diff --git a/mopidy/backends/base/playback.py b/mopidy/backends/base/playback.py index 1ab8aeda..1a47391f 100644 --- a/mopidy/backends/base/playback.py +++ b/mopidy/backends/base/playback.py @@ -498,26 +498,26 @@ class BasePlaybackProvider(object): """ Cleanup after component. - May be overridden by subclasses. + *MAY be implemented by subclasses.* """ pass def pause(self): """ - To be overridden by subclass. - Pause playback. + *MUST be implemented by subclass.* + :rtype: :class:`True` if successful, else :class:`False` """ raise NotImplementedError def play(self, track): """ - To be overridden by subclass. - Play given track. + *MUST be implemented by subclass.* + :param track: the track to play :type track: :class:`mopidy.models.Track` :rtype: :class:`True` if successful, else :class:`False` @@ -526,20 +526,20 @@ class BasePlaybackProvider(object): def resume(self): """ - To be overridden by subclass. - Resume playback at the same time position playback was paused. + *MUST be implemented by subclass.* + :rtype: :class:`True` if successful, else :class:`False` """ raise NotImplementedError def seek(self, time_position): """ - To be overridden by subclass. - Seek to a given time position. + *MUST be implemented by subclass.* + :param time_position: time position in milliseconds :type time_position: int :rtype: :class:`True` if successful, else :class:`False` @@ -548,10 +548,10 @@ class BasePlaybackProvider(object): def stop(self): """ - To be overridden by subclass. - Stop playback. + *MUST be implemented by subclass.* + :rtype: :class:`True` if successful, else :class:`False` """ raise NotImplementedError diff --git a/mopidy/backends/base/stored_playlists.py b/mopidy/backends/base/stored_playlists.py index cf14db9d..dd7380d6 100644 --- a/mopidy/backends/base/stored_playlists.py +++ b/mopidy/backends/base/stored_playlists.py @@ -133,7 +133,7 @@ class BaseStoredPlaylistsProvider(object): """ Cleanup after component. - May be overridden by subclasses. + *MAY be implemented by subclass.* """ pass @@ -152,49 +152,49 @@ class BaseStoredPlaylistsProvider(object): def create(self, name): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.create`. + + *MUST be implemented by subclass.* """ raise NotImplementedError def delete(self, playlist): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.delete`. + + *MUST be implemented by subclass.* """ raise NotImplementedError def lookup(self, uri): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.lookup`. + + *MUST be implemented by subclass.* """ raise NotImplementedError def refresh(self): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.refresh`. + + *MUST be implemented by subclass.* """ raise NotImplementedError def rename(self, playlist, new_name): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.rename`. + + *MUST be implemented by subclass.* """ raise NotImplementedError def save(self, playlist): """ - To be overridden by subclass. - See :meth:`mopidy.backends.base.BaseStoredPlaylistsController.save`. + + *MUST be implemented by subclass.* """ raise NotImplementedError diff --git a/mopidy/frontends/base.py b/mopidy/frontends/base.py index 92545b73..e15c4745 100644 --- a/mopidy/frontends/base.py +++ b/mopidy/frontends/base.py @@ -13,17 +13,27 @@ class BaseFrontend(object): self.backend = backend def start(self): - """Start the frontend.""" + """ + Start the frontend. + + *MAY be implemented by subclass.* + """ pass def destroy(self): - """Destroy the frontend.""" + """ + Destroy the frontend. + + *MAY be implemented by subclass.* + """ pass def process_message(self, message): """ Process messages for the frontend. + *MUST be implemented by subclass.* + :param message: the message :type message: dict """ diff --git a/mopidy/mixers/__init__.py b/mopidy/mixers/__init__.py index 332718a6..231154ee 100644 --- a/mopidy/mixers/__init__.py +++ b/mopidy/mixers/__init__.py @@ -42,7 +42,7 @@ class BaseMixer(object): """ Return volume as integer in range [0, 100]. :class:`None` if unknown. - *Must be implemented by subclass.* + *MUST be implemented by subclass.* """ raise NotImplementedError @@ -50,6 +50,6 @@ class BaseMixer(object): """ Set volume as integer in range [0, 100]. - *Must be implemented by subclass.* + *MUST be implemented by subclass.* """ raise NotImplementedError diff --git a/mopidy/outputs/base.py b/mopidy/outputs/base.py index bb312323..372d7d70 100644 --- a/mopidy/outputs/base.py +++ b/mopidy/outputs/base.py @@ -7,21 +7,35 @@ class BaseOutput(object): self.core_queue = core_queue def start(self): - """Start the output.""" + """ + Start the output. + + *MAY be implemented by subclasses.* + """ pass def destroy(self): - """Destroy the output.""" + """ + Destroy the output. + + *MAY be implemented by subclasses.* + """ pass def process_message(self, message): - """Process messages with the output as destination.""" + """ + Process messages with the output as destination. + + *MUST be implemented by subclass.* + """ raise NotImplementedError def play_uri(self, uri): """ Play URI. + *MUST be implemented by subclass.* + :param uri: the URI to play :type uri: string :rtype: :class:`True` if successful, else :class:`False` @@ -32,19 +46,27 @@ class BaseOutput(object): """ Deliver audio data to be played. + *MUST be implemented by subclass.* + :param capabilities: a GStreamer capabilities string :type capabilities: string """ raise NotImplementedError def end_of_data_stream(self): - """Signal that the last audio data has been delivered.""" + """ + Signal that the last audio data has been delivered. + + *MUST be implemented by subclass.* + """ raise NotImplementedError def get_position(self): """ Get position in milliseconds. + *MUST be implemented by subclass.* + :rtype: int """ raise NotImplementedError @@ -53,6 +75,8 @@ class BaseOutput(object): """ Set position in milliseconds. + *MUST be implemented by subclass.* + :param position: the position in milliseconds :type volume: int :rtype: :class:`True` if successful, else :class:`False` @@ -63,6 +87,8 @@ class BaseOutput(object): """ Set playback state. + *MUST be implemented by subclass.* + :param state: the state :type state: string :rtype: :class:`True` if successful, else :class:`False` @@ -73,6 +99,8 @@ class BaseOutput(object): """ Get volume level for software mixer. + *MUST be implemented by subclass.* + :rtype: int in range [0..100] """ raise NotImplementedError @@ -81,6 +109,8 @@ class BaseOutput(object): """ Set volume level for software mixer. + *MUST be implemented by subclass.* + :param volume: the volume in the range [0..100] :type volume: int :rtype: :class:`True` if successful, else :class:`False`