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

docs: Refresh of remaining parts of core API docs

Browse Source
This commit is contained in:
Thomas Adamcik 2015-04-24 00:30:40 +02:00
parent 830a19ca70
commit 461061f1be
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/api/core.rst
View File

@ -10,7 +10,8 @@ Core API
The core API is the interface that is used by frontends like
: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.
as a Pykka actor. If you are only interested in being notified about changes
in core see :class:`~mopidy.core.CoreListener`.
.. autoclass:: mopidy.core.Core
@ -172,17 +173,23 @@ Manipulating
Mixer controller
================
.. autoclass:: mopidy.core.MixerController
:members:
.. class:: mopidy.core.MixerController
.. automethod:: mopidy.core.MixerController.get_mute
.. automethod:: mopidy.core.MixerController.set_mute
.. automethod:: mopidy.core.MixerController.get_volume
.. automethod:: mopidy.core.MixerController.set_volume
History controller
==================
.. autoclass:: mopidy.core.HistoryController
:members:
.. class:: mopidy.core.HistoryController
Core listener
=============
.. automethod:: mopidy.core.HistoryController.get_history
.. automethod:: mopidy.core.HistoryController.get_length
Core events
===========
.. autoclass:: mopidy.core.CoreListener
:members: