summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-04-25 13:21:36 +0200
committerMax Kellermann <max@duempel.org>2009-04-25 13:21:36 +0200
commitde95caa346e1cda050212b1e9425bfd8b6125703 (patch)
treefb2ac4d60eeee8ff8973ff34f9dc9154bcfeea95
parenteea2866190a4a26d8e52f023e535e7f67fee6152 (diff)
doc: added more audio output documentation
-rw-r--r--doc/user.xml64
1 files changed, 63 insertions, 1 deletions
diff --git a/doc/user.xml b/doc/user.xml
index c50f977d6..b2bfc172d 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -113,7 +113,69 @@ cd mpd-0.14.2</programlisting>
name "my ALSA device"
device "hw:0"
}
-</programlisting>
+ </programlisting>
+
+ <para>
+ The following table lists the <varname>audio_output</varname>
+ options valid for all plugins:
+ </para>
+
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ Name
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <varname>type</varname>
+ </entry>
+ <entry>
+ The name of the plugin.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <varname>name</varname>
+ </entry>
+ <entry>
+ The name of the audio output. It is visible to the
+ client. Some plugins also use it internally, e.g. as
+ a name registered in the PULSE server.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <varname>format</varname>
+ </entry>
+ <entry>
+ Always open the audio output with the specified audio
+ format (samplerate:bits:channels), regardless of the
+ format of the input file. This is optional for most
+ plugins.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <varname>enabled</varname>
+ <parameter>yes|no</parameter>
+ </entry>
+ <entry>
+ Specifies whether this audio output is enabled when
+ MPD is started. By default, all audio outputs are
+ enabled.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</section>
</chapter>