andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Make it more clear what each part of core does right away

Browse Source
This commit is contained in:
Thomas Adamcik 2015-04-24 00:13:30 +02:00
parent 0afe8ef54c
commit 907f920f18
1 changed files with 28 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/api/core.rst
View File

@ -14,38 +14,44 @@ as a Pykka actor.
.. autoclass:: mopidy.core.Core
.. attribute:: tracklist
Manages everything related to the list of tracks we will play.
See :class:`~mopidy.core.TracklistController`.
.. attribute:: playback
Manages playback state and the current playing track.
See :class:`~mopidy.core.PlaybackController`.
.. attribute:: library
Manages the music library, e.g. searching and browsing for music.
See :class:`~mopidy.core.LibraryController`.
.. attribute:: playlists
Manages stored playlists. See :class:`~mopidy.core.PlaylistsController`.
.. attribute:: mixer
Manages volume and muting. See :class:`~mopidy.core.MixerController`.
.. attribute:: history
Keeps record of what tracks have been played.
See :class:`~mopidy.core.HistoryController`.
.. automethod:: get_uri_schemes
.. automethod:: get_version
.. autoattribute:: tracklist
:annotation:
.. autoattribute:: playback
:annotation:
.. autoattribute:: library
:annotation:
.. autoattribute:: playlists
:annotation:
.. autoattribute:: mixer
:annotation:
.. autoattribute:: history
:annotation:
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
------------
@ -107,8 +113,6 @@ seek, and volume control.
History controller
==================
Keeps record of what tracks have been played.
.. autoclass:: mopidy.core.HistoryController
:members:
@ -116,8 +120,6 @@ Keeps record of what tracks have been played.
Playlists controller
====================
Manages persistence of playlists.
.. autoclass:: mopidy.core.PlaylistsController
:members:
@ -125,8 +127,6 @@ Manages persistence of playlists.
Library controller
==================
Manages the music library, e.g. searching for tracks to be added to a playlist.
.. autoclass:: mopidy.core.LibraryController
:members:
@ -134,8 +134,6 @@ Manages the music library, e.g. searching for tracks to be added to a playlist.
Mixer controller
================
Manages volume and muting.
.. autoclass:: mopidy.core.MixerController
:members: