docs: Refresh PlaybackController documentation
This commit is contained in:
parent
b6b1bb2489
commit
996af72af7
@ -101,14 +101,41 @@ Options
|
|||||||
Playback controller
|
Playback controller
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Manages playback, with actions like play, pause, stop, next, previous,
|
|
||||||
seek, and volume control.
|
|
||||||
|
|
||||||
.. autoclass:: mopidy.core.PlaybackState
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. autoclass:: mopidy.core.PlaybackController
|
.. autoclass:: mopidy.core.PlaybackController
|
||||||
:members:
|
|
||||||
|
Playback control
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.play
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.next
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.previous
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.stop
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.pause
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.resume
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.seek
|
||||||
|
|
||||||
|
Current track
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_current_tl_track
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_current_track
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_stream_title
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_time_position
|
||||||
|
|
||||||
|
Playback states
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_state
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.set_state
|
||||||
|
|
||||||
|
.. class:: mopidy.core.PlaybackState
|
||||||
|
|
||||||
|
.. attribute:: STOPPED
|
||||||
|
:annotation: = 'stopped'
|
||||||
|
.. attribute:: PLAYING
|
||||||
|
:annotation: = 'playing'
|
||||||
|
.. attribute:: PAUSED
|
||||||
|
:annotation: = 'paused'
|
||||||
|
|
||||||
History controller
|
History controller
|
||||||
==================
|
==================
|
||||||
@ -168,3 +195,16 @@ TracklistController
|
|||||||
.. autoattribute:: mopidy.core.TracklistController.random
|
.. autoattribute:: mopidy.core.TracklistController.random
|
||||||
.. autoattribute:: mopidy.core.TracklistController.repeat
|
.. autoattribute:: mopidy.core.TracklistController.repeat
|
||||||
.. autoattribute:: mopidy.core.TracklistController.single
|
.. autoattribute:: mopidy.core.TracklistController.single
|
||||||
|
|
||||||
|
PlaylistsController
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_mute
|
||||||
|
.. automethod:: mopidy.core.PlaybackController.get_volume
|
||||||
|
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.current_tl_track
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.current_track
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.state
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.time_position
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.mute
|
||||||
|
.. autoattribute:: mopidy.core.PlaybackController.volume
|
||||||
|
|||||||
@ -267,8 +267,10 @@ class PlaybackController(object):
|
|||||||
|
|
||||||
def play(self, tl_track=None, tlid=None):
|
def play(self, tl_track=None, tlid=None):
|
||||||
"""
|
"""
|
||||||
Play the given track, or if the given track is :class:`None`, play the
|
Play the given track, or if the given tl_track and tlid is
|
||||||
currently active track.
|
:class:`None`, play the currently active track.
|
||||||
|
|
||||||
|
Note that the track **must** already be in the tracklist.
|
||||||
|
|
||||||
:param tl_track: track to play
|
:param tl_track: track to play
|
||||||
:type tl_track: :class:`mopidy.models.TlTrack` or :class:`None`
|
:type tl_track: :class:`mopidy.models.TlTrack` or :class:`None`
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user