docs: Improve core actor docs
This commit is contained in:
parent
3dba4f4208
commit
0afe8ef54c
@ -8,11 +8,34 @@ Core API
|
||||
:synopsis: Core API for use by frontends
|
||||
|
||||
The core API is the interface that is used by frontends like
|
||||
:mod:`mopidy.http` and :mod:`mopidy.mpd`. The core layer is inbetween the
|
||||
frontends and the backends.
|
||||
:mod:`mopidy.http` and :mod:`mopidy.mpd`. The core layer is in between the
|
||||
frontends and the backends. Don't forget that you will be accessing core
|
||||
as a Pykka actor.
|
||||
|
||||
.. autoclass:: mopidy.core.Core
|
||||
:members:
|
||||
|
||||
.. 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
|
||||
====================
|
||||
@ -125,6 +148,12 @@ Core listener
|
||||
Deprecated API features
|
||||
=======================
|
||||
|
||||
Core
|
||||
----
|
||||
|
||||
.. autoattribute:: mopidy.core.Core.version
|
||||
.. autoattribute:: mopidy.core.Core.uri_schemes
|
||||
|
||||
TracklistController
|
||||
-------------------
|
||||
|
||||
|
||||
@ -23,28 +23,22 @@ class Core(
|
||||
mixer.MixerListener):
|
||||
|
||||
library = None
|
||||
"""The library controller. An instance of
|
||||
:class:`mopidy.core.LibraryController`."""
|
||||
"""An instance of :class:`~mopidy.core.LibraryController`"""
|
||||
|
||||
history = None
|
||||
"""The playback history controller. An instance of
|
||||
:class:`mopidy.core.HistoryController`."""
|
||||
"""An instance of :class:`~mopidy.core.HistoryController`"""
|
||||
|
||||
mixer = None
|
||||
"""The mixer controller. An instance of
|
||||
:class:`mopidy.core.MixerController`."""
|
||||
"""An instance of :class:`~mopidy.core.MixerController`"""
|
||||
|
||||
playback = None
|
||||
"""The playback controller. An instance of
|
||||
:class:`mopidy.core.PlaybackController`."""
|
||||
"""An instance of :class:`~mopidy.core.PlaybackController`"""
|
||||
|
||||
playlists = None
|
||||
"""The playlists controller. An instance of
|
||||
:class:`mopidy.core.PlaylistsController`."""
|
||||
"""An instance of :class:`~mopidy.core.PlaylistsController`"""
|
||||
|
||||
tracklist = None
|
||||
"""The tracklist controller. An instance of
|
||||
:class:`mopidy.core.TracklistController`."""
|
||||
"""An instance of :class:`~mopidy.core.TracklistController`"""
|
||||
|
||||
def __init__(self, config=None, mixer=None, backends=None, audio=None):
|
||||
super(Core, self).__init__()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user