doc: merged protocol documentation from the wiki
Over the years, a lot of commands have been added to MPD which were documented only in the wiki (http://mpd.wikia.com/wiki/Protocol_Reference). Merge all missing commands from there.
This commit is contained in:
Monika Brinkert
parent
63a885026a
commit
a165ee25e8
323
doc/protocol.xml
323
doc/protocol.xml
|
|
@ -194,7 +194,8 @@
|
||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Reports the current status of the player and the volume level.
|
Reports the current status of the player and the volume
|
||||||
|
level.
|
||||||
</para>
|
</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
@ -421,6 +422,37 @@
|
||||||
<title>Controlling playback</title>
|
<title>Controlling playback</title>
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
<varlistentry id="command_next">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>next</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Plays next song in the playlist.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_pause">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>pause</command>
|
||||||
|
<arg choice="req"><replaceable>PAUSE</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Toggles pause/resumes playing, <varname>PAUSE</varname> is 0 or 1.
|
||||||
|
</para>
|
||||||
|
<note>
|
||||||
|
<para>
|
||||||
|
The use of pause command w/o the PAUSE argument is
|
||||||
|
deprecated.
|
||||||
|
</para>
|
||||||
|
</note>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry id="command_play">
|
<varlistentry id="command_play">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -449,18 +481,6 @@
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry id="command_next">
|
|
||||||
<term>
|
|
||||||
<cmdsynopsis>
|
|
||||||
<command>next</command>
|
|
||||||
</cmdsynopsis>
|
|
||||||
</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Plays next song in the playlist.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry id="command_previous">
|
<varlistentry id="command_previous">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -473,25 +493,7 @@
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry id="command_pause">
|
|
||||||
<term>
|
|
||||||
<cmdsynopsis>
|
|
||||||
<command>pause</command>
|
|
||||||
<arg choice="req"><replaceable>PAUSE</replaceable></arg>
|
|
||||||
</cmdsynopsis>
|
|
||||||
</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Toggles pause/resumes playing, <varname>PAUSE</varname> is 0 or 1.
|
|
||||||
</para>
|
|
||||||
<note>
|
|
||||||
<para>
|
|
||||||
The use of pause command w/o the PAUSE argument is
|
|
||||||
deprecated.
|
|
||||||
</para>
|
|
||||||
</note>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry id="command_seek">
|
<varlistentry id="command_seek">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -672,6 +674,21 @@ OK
|
||||||
</note>
|
</note>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistfind">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistfind</command>
|
||||||
|
<arg choice="req"><replaceable>TAG</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>NEEDLE</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Finds songs in the current playlist with strict
|
||||||
|
matching.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry id="command_playlistid">
|
<varlistentry id="command_playlistid">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -702,6 +719,21 @@ OK
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistsearch">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistsearch</command>
|
||||||
|
<arg choice="req"><replaceable>TAG</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>NEEDLE</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Searches case-sensitively for partial matches in the
|
||||||
|
current playlist.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry id="command_plchanges">
|
<varlistentry id="command_plchanges">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -789,17 +821,30 @@ OK
|
||||||
<title>Stored playlists</title>
|
<title>Stored playlists</title>
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
<varlistentry id="command_load">
|
<varlistentry id="command_listplaylist">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>load</command>
|
<command>listplaylist</command>
|
||||||
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Loads the playlist <filename>NAME.m3u</filename> from
|
Lists the files in the playlist
|
||||||
the playlist directory.
|
<filename>NAME.m3u</filename>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_listplaylistinfo">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>listplaylistinfo</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Lists songs in the playlist <filename>NAME.m3u</filename>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
@ -822,6 +867,98 @@ OK
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
<varlistentry id="command_load">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>load</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Loads the playlist <filename>NAME.m3u</filename> from
|
||||||
|
the playlist directory.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistadd">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistadd</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>URI</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Adds <varname>URI</varname> to the playlist
|
||||||
|
<filename>NAME.m3u</filename>.
|
||||||
|
</para>
|
||||||
|
<para>
|
||||||
|
<filename>NAME.m3u</filename> will be created if it does
|
||||||
|
not exist.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistclear">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistclear</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Clears the playlist <filename>NAME.m3u</filename>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistdelete">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistdelete</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>SONGID</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Deletes <varname>SONGID</varname> from the
|
||||||
|
playlist <filename>NAME.m3u</filename>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_playlistmove">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>playlistmove</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>SONGID</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>SONGPOS</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Moves <varname>SONGID</varname> in the playlist
|
||||||
|
<filename>NAME.m3u</filename> to the position
|
||||||
|
<varname>SONGPOS</varname>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_rename">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>rename</command>
|
||||||
|
<arg choice="req"><replaceable>NAME</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>NEW_NAME</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Renames the playlist <filename>NAME.m3u</filename> to <filename>NEW_NAME.m3u</filename>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry id="command_rm">
|
<varlistentry id="command_rm">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -857,6 +994,21 @@ OK
|
||||||
<title>The music database</title>
|
<title>The music database</title>
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
<varlistentry id="command_count">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>count</command>
|
||||||
|
<arg choice="req"><replaceable>TAG</replaceable></arg>
|
||||||
|
<arg choice="req"><replaceable>NEEDLE</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Counts the number of songs and their total playtime in
|
||||||
|
the db matching <varname>TAG</varname> exactly.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
<varlistentry id="command_find">
|
<varlistentry id="command_find">
|
||||||
<term>
|
<term>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
|
|
@ -1054,5 +1206,104 @@ OK
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
</variablelist>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>Audio output devices</title>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry id="command_disableoutput">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>disableoutput</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Turns an output off.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_enableoutput">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>enableoutput</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Turns an output on.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_outputs">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>outputs</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Shows information about all outputs.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<title>Reflection</title>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry id="command_commands">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>commands</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Shows which commands the current user has access to.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_notcommands">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>notcommands</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Shows which commands the current user does not have
|
||||||
|
access to.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_tagtypes">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>tagtypes</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Shows a list of available song metadata.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry id="command_urlhandlers">
|
||||||
|
<term>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>urlhandlers</command>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Gets a list of available URL handlers.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
</section>
|
||||||
</chapter>
|
</chapter>
|
||||||
</book>
|
</book>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue