From c897877a71982a5f9760333a3d9c1b785b9a728f Mon Sep 17 00:00:00 2001 From: Thomas Adamcik Date: Thu, 23 Apr 2015 21:48:07 +0200 Subject: [PATCH] docs: Manually split tracklist class documentation --- docs/api/core.rst | 80 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 70 insertions(+), 10 deletions(-) diff --git a/docs/api/core.rst b/docs/api/core.rst index 27ab2f57..2d1be5dc 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -14,6 +14,60 @@ frontends and the backends. .. autoclass:: mopidy.core.Core :members: +Tracklist controller +==================== + +.. autoclass:: mopidy.core.TracklistController + +Manages everything related to the tracks we are currently playing. This is +likely where you need to start as only tracks that are in the *tracklist* can be +played. + +Manipulating +------------ + +.. automethod:: mopidy.core.TracklistController.add +.. automethod:: mopidy.core.TracklistController.remove +.. automethod:: mopidy.core.TracklistController.clear +.. automethod:: mopidy.core.TracklistController.move +.. automethod:: mopidy.core.TracklistController.shuffle + +Current state +------------- + +.. automethod:: mopidy.core.TracklistController.get_tl_tracks +.. automethod:: mopidy.core.TracklistController.index +.. automethod:: mopidy.core.TracklistController.get_version + +.. automethod:: mopidy.core.TracklistController.get_length +.. automethod:: mopidy.core.TracklistController.get_tracks + +.. automethod:: mopidy.core.TracklistController.slice +.. automethod:: mopidy.core.TracklistController.filter + +Future state +------------ + +.. automethod:: mopidy.core.TracklistController.get_eot_tlid +.. automethod:: mopidy.core.TracklistController.get_next_tlid +.. automethod:: mopidy.core.TracklistController.get_previous_tlid + +.. automethod:: mopidy.core.TracklistController.eot_track +.. automethod:: mopidy.core.TracklistController.next_track +.. automethod:: mopidy.core.TracklistController.previous_track + +Options +------- + +.. automethod:: mopidy.core.TracklistController.get_consume +.. automethod:: mopidy.core.TracklistController.set_consume +.. automethod:: mopidy.core.TracklistController.get_random +.. automethod:: mopidy.core.TracklistController.set_random +.. automethod:: mopidy.core.TracklistController.get_repeat +.. automethod:: mopidy.core.TracklistController.set_repeat +.. automethod:: mopidy.core.TracklistController.get_single +.. automethod:: mopidy.core.TracklistController.set_single + Playback controller =================== @@ -27,16 +81,6 @@ seek, and volume control. .. autoclass:: mopidy.core.PlaybackController :members: - -Tracklist controller -==================== - -Manages everything related to the tracks we are currently playing. - -.. autoclass:: mopidy.core.TracklistController - :members: - - History controller ================== @@ -77,3 +121,19 @@ Core listener .. autoclass:: mopidy.core.CoreListener :members: + +Deprecated API features +======================= + +TracklistController +------------------- + +.. autoattribute:: mopidy.core.TracklistController.tl_tracks +.. autoattribute:: mopidy.core.TracklistController.tracks +.. autoattribute:: mopidy.core.TracklistController.version +.. autoattribute:: mopidy.core.TracklistController.length + +.. autoattribute:: mopidy.core.TracklistController.consume +.. autoattribute:: mopidy.core.TracklistController.random +.. autoattribute:: mopidy.core.TracklistController.repeat +.. autoattribute:: mopidy.core.TracklistController.single