docs: Freshen up the API docs
This commit is contained in:
Stein Magnus Jodal
parent
f9c329bffd
commit
cca1c0e234
@ -2,6 +2,10 @@
|
||||
:mod:`mopidy.backends`
|
||||
**********************
|
||||
|
||||
.. automodule:: mopidy.backends
|
||||
:synopsis: Backend API
|
||||
|
||||
|
||||
The backend and its controllers
|
||||
===============================
|
||||
|
||||
@ -16,13 +20,10 @@ The backend and its controllers
|
||||
Backend API
|
||||
===========
|
||||
|
||||
.. automodule:: mopidy.backends
|
||||
:synopsis: Backend interface.
|
||||
|
||||
.. note::
|
||||
|
||||
Currently this only documents the API that is available for use by
|
||||
frontends like :class:`mopidy.mpd.handler`, and not what is required to
|
||||
frontends like :mod:`mopidy.frontends.mpd`, and not what is required to
|
||||
implement your own backend. :class:`mopidy.backends.base.BaseBackend` and
|
||||
its controllers implements many of these methods in a matter that should be
|
||||
independent of most concrete backend implementations, so you should
|
||||
@ -81,40 +82,34 @@ Manages the music library, e.g. searching for tracks to be added to a playlist.
|
||||
:undoc-members:
|
||||
|
||||
|
||||
Spotify backends
|
||||
================
|
||||
|
||||
:mod:`mopidy.backends.despotify` -- Despotify backend
|
||||
-----------------------------------------------------
|
||||
=====================================================
|
||||
|
||||
.. automodule:: mopidy.backends.despotify
|
||||
:synopsis: Spotify backend using the despotify library.
|
||||
:synopsis: Spotify backend using the Despotify library
|
||||
:members:
|
||||
|
||||
|
||||
:mod:`mopidy.backends.libspotify` -- Libspotify backend
|
||||
-------------------------------------------------------
|
||||
|
||||
.. automodule:: mopidy.backends.libspotify
|
||||
:synopsis: Spotify backend using the libspotify library.
|
||||
:members:
|
||||
|
||||
|
||||
Other backends
|
||||
==============
|
||||
|
||||
:mod:`mopidy.backends.dummy` -- Dummy backend
|
||||
---------------------------------------------
|
||||
:mod:`mopidy.backends.dummy` -- Dummy backend for testing
|
||||
=========================================================
|
||||
|
||||
.. automodule:: mopidy.backends.dummy
|
||||
:synopsis: Dummy backend used for testing.
|
||||
:synopsis: Dummy backend used for testing
|
||||
:members:
|
||||
|
||||
|
||||
:mod:`mopidy.backends.gstreamer` -- GStreamer backend
|
||||
-----------------------------------------------------
|
||||
=====================================================
|
||||
|
||||
.. automodule:: mopidy.backends.gstreamer
|
||||
:synopsis: Backend for playing music from a local music archive using the
|
||||
GStreamer library.
|
||||
GStreamer library
|
||||
:members:
|
||||
|
||||
|
||||
:mod:`mopidy.backends.libspotify` -- Libspotify backend
|
||||
=======================================================
|
||||
|
||||
.. automodule:: mopidy.backends.libspotify
|
||||
:synopsis: Spotify backend using the libspotify library
|
||||
:members:
|
||||
|
||||
@ -13,6 +13,17 @@ simply instantiate a mixer and read/write to the ``volume`` attribute::
|
||||
>>> mixer.volume
|
||||
80
|
||||
|
||||
Most users will use one of the internal mixers which controls the volume on the
|
||||
computer running Mopidy. If you do not specify which mixer you want to use in
|
||||
the settings, Mopidy will choose one for you based upon what OS you run. See
|
||||
:attr:`mopidy.settings.MIXER` for the defaults.
|
||||
|
||||
Mopidy also supports controlling volume on other hardware devices instead of on
|
||||
the computer running Mopidy through the use of custom mixer implementations. To
|
||||
enable one of the hardware device mixers, you must the set
|
||||
:attr:`mopidy.settings.MIXER` setting to point to one of the classes found
|
||||
below, and possibly add some extra settings required by the mixer you choose.
|
||||
|
||||
|
||||
Mixer API
|
||||
=========
|
||||
@ -21,76 +32,56 @@ All mixers should subclass :class:`mopidy.mixers.BaseMixer` and override
|
||||
methods as described below.
|
||||
|
||||
.. automodule:: mopidy.mixers
|
||||
:synopsis: Sound mixer interface.
|
||||
:synopsis: Mixer API
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
Internal mixers
|
||||
===============
|
||||
|
||||
Most users will use one of these internal mixers which controls the volume on
|
||||
the computer running Mopidy. If you do not specify which mixer you want to use
|
||||
in the settings, Mopidy will choose one for you based upon what OS you run. See
|
||||
:attr:`mopidy.settings.MIXER` for the defaults.
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.alsa` -- ALSA mixer
|
||||
---------------------------------------
|
||||
:mod:`mopidy.mixers.alsa` -- ALSA mixer for Linux
|
||||
=================================================
|
||||
|
||||
.. automodule:: mopidy.mixers.alsa
|
||||
:synopsis: ALSA mixer for Linux.
|
||||
:synopsis: ALSA mixer for Linux
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.alsa.AlsaMixer
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.dummy` -- Dummy mixer
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: mopidy.mixers.dummy
|
||||
:synopsis: Dummy mixer for testing.
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.dummy
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.osa` -- Osa mixer
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: mopidy.mixers.osa
|
||||
:synopsis: Osa mixer for OS X.
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.osa
|
||||
|
||||
|
||||
External device mixers
|
||||
======================
|
||||
|
||||
Mopidy supports controlling volume on external devices instead of on the
|
||||
computer running Mopidy through the use of custom mixer implementations. To
|
||||
enable one of the following mixers, you must the set
|
||||
:attr:`mopidy.settings.MIXER` setting to point to one of the classes
|
||||
found below, and possibly add some extra settings required by the mixer you
|
||||
choose.
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.denon` -- Denon amplifier mixer
|
||||
---------------------------------------------------
|
||||
:mod:`mopidy.mixers.denon` -- Hardware mixer for Denon amplifiers
|
||||
=================================================================
|
||||
|
||||
.. automodule:: mopidy.mixers.denon
|
||||
:synopsis: Denon amplifier mixer.
|
||||
:synopsis: Hardware mixer for Denon amplifiers
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.denon
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.nad` -- NAD amplifier mixer
|
||||
-----------------------------------------------
|
||||
:mod:`mopidy.mixers.dummy` -- Dummy mixer for testing
|
||||
=====================================================
|
||||
|
||||
.. automodule:: mopidy.mixers.dummy
|
||||
:synopsis: Dummy mixer for testing
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.dummy
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.osa` -- Osa mixer for OS X
|
||||
==============================================
|
||||
|
||||
.. automodule:: mopidy.mixers.osa
|
||||
:synopsis: Osa mixer for OS X
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.osa
|
||||
|
||||
|
||||
:mod:`mopidy.mixers.nad` -- Hardware mixer for NAD amplifiers
|
||||
=============================================================
|
||||
|
||||
.. automodule:: mopidy.mixers.nad
|
||||
:synopsis: NAD amplifier mixer.
|
||||
:synopsis: Hardware mixer for NAD amplifiers
|
||||
:members:
|
||||
|
||||
.. inheritance-diagram:: mopidy.mixers.nad
|
||||
|
||||
@ -23,6 +23,6 @@ Data model API
|
||||
==============
|
||||
|
||||
.. automodule:: mopidy.models
|
||||
:synopsis: Immutable data models.
|
||||
:synopsis: Data model API
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
@ -2,11 +2,15 @@
|
||||
:mod:`mopidy.frontends.mpd`
|
||||
***************************
|
||||
|
||||
.. automodule:: mopidy.frontends.mpd
|
||||
:synopsis: MPD frontend
|
||||
|
||||
|
||||
MPD protocol implementation
|
||||
===========================
|
||||
|
||||
.. automodule:: mopidy.frontends.mpd.frontend
|
||||
:synopsis: Our MPD protocol implementation.
|
||||
:synopsis: MPD protocol implementation
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
@ -15,7 +19,7 @@ MPD server implementation
|
||||
=========================
|
||||
|
||||
.. automodule:: mopidy.frontends.mpd.server
|
||||
:synopsis: Our MPD server implementation.
|
||||
:synopsis: MPD server implementation
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
@ -22,6 +22,6 @@ Available settings
|
||||
==================
|
||||
|
||||
.. automodule:: mopidy.settings
|
||||
:synopsis: Available settings and their default values.
|
||||
:synopsis: Available settings and their default values
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user