aboutsummaryrefslogtreecommitdiffstats
path: root/doc/protocol.xml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/protocol.xml144
1 files changed, 122 insertions, 22 deletions
diff --git a/doc/protocol.xml b/doc/protocol.xml
index 2bc7d55ae..1f053acaa 100644
--- a/doc/protocol.xml
+++ b/doc/protocol.xml
@@ -67,6 +67,20 @@
successful command executed in the command list.
</para>
</section>
+
+ <section>
+ <title>Ranges</title>
+
+ <para>
+ Some commands (e.g. <link
+ linkend="command_delete"><command>delete</command></link>)
+ allow specifying a range in the form
+ <parameter>START:END</parameter> (the <varname>END</varname>
+ item is not included in the range, similar to ranges in the
+ Python programming language). If <varname>END</varname> is
+ omitted, then the maximum possible value is assumed.
+ </para>
+ </section>
</chapter>
<chapter>
@@ -123,7 +137,7 @@
</term>
<listitem>
<para>
- <footnote id="since_0_14"><simpara>Since MPD 0.14</simpara></footnote>
+ <footnote id="since_0_14"><simpara>Introduced with MPD 0.14</simpara></footnote>
Waits until there is a noteworthy change in one or more
of MPD's subsystems. As soon as there is one, it lists
all changed systems in a line in the format
@@ -139,6 +153,15 @@
</listitem>
<listitem>
<para>
+ <returnvalue>update</returnvalue>: a database update
+ has started or finished. If the database was
+ modified during the update, the
+ <returnvalue>database</returnvalue> event is also
+ emitted.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<returnvalue>stored_playlist</returnvalue>: a stored
playlist has been modified, renamed, created or
deleted
@@ -172,7 +195,7 @@
<para>
<returnvalue>options</returnvalue>: options like
<option>repeat</option>, <option>random</option>,
- <option>crossfade</option>
+ <option>crossfade</option>, replay gain
</para>
</listitem>
</itemizedlist>
@@ -191,9 +214,6 @@
MPD will only send notifications when something changed in
one of the specified subsytems.
</para>
- <simpara>
- Since <application>MPD</application> 0.14
- </simpara>
</listitem>
</varlistentry>
<varlistentry id="command_status">
@@ -223,15 +243,15 @@
<listitem>
<para>
<varname>single</varname>:
+ <footnote id="since_0_15"><simpara>Introduced with MPD 0.15</simpara></footnote>
<returnvalue>0 or 1</returnvalue>
- <footnote id="since_0_15"><simpara>Since MPD 0.15</simpara></footnote>
</para>
</listitem>
<listitem>
<para>
<varname>consume</varname>:
- <returnvalue>0 or 1</returnvalue>
<footnoteref linkend="since_0_15"/>
+ <returnvalue>0 or 1</returnvalue>
</para>
</listitem>
<listitem>
@@ -297,6 +317,16 @@
</listitem>
<listitem>
<para>
+ <varname>elapsed</varname>:
+ <footnote id="since_0_16"><simpara>Introduced with MPD 0.16</simpara></footnote>
+ <returnvalue>
+ Total time elapsed within the current song, but
+ with higher resolution.
+ </returnvalue>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<varname>bitrate</varname>:
<returnvalue>instantaneous bitrate in
kbps</returnvalue>
@@ -471,23 +501,43 @@
</para>
</listitem>
</varlistentry>
- <varlistentry id="command_volume">
+ <varlistentry id="command_replay_gain_mode">
<term>
<cmdsynopsis>
- <command>volume</command>
- <arg choice="req"><replaceable>CHANGE</replaceable></arg>
+ <command>replay_gain_mode</command>
+ <arg choice="req"><replaceable>MODE</replaceable></arg>
</cmdsynopsis>
</term>
<listitem>
<para>
- Changes volume by amount <varname>CHANGE</varname>.
+ Sets the replay gain mode. One of
+ <parameter>off</parameter>,
+ <parameter>track</parameter>,
+ <parameter>album</parameter>.
+ </para>
+ <para>
+ Changing the mode during playback may take several
+ seconds, because the new settings does not affect the
+ buffered data.
+ </para>
+ <para>
+ This command triggers the
+ <returnvalue>options</returnvalue> idle event.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="command_replay_gain_status">
+ <term>
+ <cmdsynopsis>
+ <command>replay_gain_status</command>
+ </cmdsynopsis>
+ </term>
+ <listitem>
+ <para>
+ Prints replay gain options. Currently, only the
+ variable <varname>replay_gain_mode</varname> is
+ returned.
</para>
- <note>
- <para>
- <command>volume</command> is deprecated, use
- <command>setvol</command> instead.
- </para>
- </note>
</listitem>
</varlistentry>
</variablelist>
@@ -648,10 +698,7 @@
</para>
<para>
<varname>URI</varname> is always a single file or
- URL. <varname>POSITION</varname> is optional, a
- negative number means it is relative to the currently
- playing song in the playlist (if there is one).
- For example:
+ URL. For example:
</para>
<screen>
addid "foo.mp3"
@@ -676,7 +723,10 @@ OK
<term>
<cmdsynopsis>
<command>delete</command>
- <arg choice="req"><replaceable>SONGPOS</replaceable></arg>
+ <group>
+ <arg choice="req"><replaceable>POS</replaceable></arg>
+ <arg choice="req"><replaceable>START:END</replaceable></arg>
+ </group>
</cmdsynopsis>
</term>
<listitem>
@@ -1118,6 +1168,23 @@ OK
</para>
</listitem>
</varlistentry>
+ <varlistentry id="command_findadd">
+ <term>
+ <cmdsynopsis>
+ <command>findadd</command>
+ <arg choice="req"><replaceable>TYPE</replaceable></arg>
+ <arg choice="req"><replaceable>WHAT</replaceable></arg>
+ </cmdsynopsis>
+ </term>
+ <listitem>
+ <para>
+ Finds songs in the db that are exactly
+ <varname>WHAT</varname> and adds them to current playlist.
+ <varname>TYPE</varname> can be any tag supported by MPD.
+ <varname>WHAT</varname> is what to find.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry id="command_list">
<term>
<cmdsynopsis>
@@ -1231,6 +1298,20 @@ OK
</para>
</listitem>
</varlistentry>
+ <varlistentry id="command_rescan">
+ <term>
+ <cmdsynopsis>
+ <command>rescan</command>
+ <arg choice="opt"><replaceable>URI</replaceable></arg>
+ </cmdsynopsis>
+ </term>
+ <listitem>
+ <para>
+ Same as <command>update</command>, but also rescans
+ unmodified files.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</section>
@@ -1508,6 +1589,25 @@ OK
</para>
</listitem>
</varlistentry>
+ <varlistentry id="command_decoders">
+ <term>
+ <cmdsynopsis>
+ <command>decoders</command>
+ </cmdsynopsis>
+ </term>
+ <listitem>
+ <para>
+ Print a list of decoder plugins, followed by their
+ supported suffixes and MIME types. Example response:
+ </para>
+ <programlisting>plugin: mad
+suffix: mp3
+suffix: mp2
+mime_type: audio/mpeg
+plugin: mpcdec
+suffix: mpc</programlisting>
+ </listitem>
+ </varlistentry>
</variablelist>
</section>
</chapter>