protocol.rst 49.4 KB
Newer Older
1 2 3
########
Protocol
########
4 5

General protocol syntax
6
***********************
7 8 9 10

Protocol overview
=================

11
The :program:`MPD` command protocol exchanges
12 13 14 15 16
line-based text records between client and server over TCP.
Once the client is connected to the server, they conduct a
conversation until the client closes the connection. The
conversation flow is always initiated by the client.

17 18 19
All data between the client and the server is encoded in
UTF-8.

20 21 22 23 24 25
The client transmits a command sequence, terminated by the
newline character ``\n``.  The server will
respond with one or more lines, the last of which will be a
completion code.

When the client connects to the server, the server will answer
26
with the following line::
27

28
 OK MPD version
29 30 31 32 33 34 35 36 37

where ``version`` is a version identifier such as
0.12.2.  This version identifier is the version of the protocol
spoken, not the real version of the daemon.  (There is no way to
retrieve this real version identifier from the connection.)

Requests
========

38 39 40
.. code-block:: none

 COMMAND [ARG...]
41 42 43 44 45 46 47 48 49 50 51 52 53 54

If arguments contain spaces, they should be surrounded by double
quotation marks.

Argument strings are separated from the command and any other
arguments by linear white-space (' ' or '\\t').

Responses
=========

A command returns ``OK`` on completion or
``ACK some error`` on failure.  These
denote the end of command execution.

55 56 57 58 59 60 61 62 63 64 65 66 67
Some commands return more data before the response ends with ``OK``.
Each line is usually in the form ``NAME: VALUE``.  Example::

  foo: bar
  OK

.. _binary:

Binary Responses
----------------

Some commands can return binary data.  This is initiated by a line
containing ``binary: 1234`` (followed as usual by a newline).  After
68
that, the specified number of bytes of binary data follows, then a
69 70 71
newline, and finally the ``OK`` line.

If the object to be transmitted is large, the server may choose a
72 73 74 75 76 77 78 79
reasonable chunk size and transmit only a portion.  The maximum chunk
size can be changed by clients with the :ref:`binarylimit
<command_binarylimit>` command.

Usually, the response also contains a ``size`` line which specifies
the total (uncropped) size, and the command usually has a way to
specify an offset into the object; this way, the client can copy the
whole file without blocking the connection for too long.
80 81

Example::
82 83 84

  foo: bar
  binary: 42
85 86
  <42 bytes>
  OK
87 88


89 90 91 92 93 94 95
Failure responses
-----------------

The nature of the error can be gleaned from the information
that follows the ``ACK``.
``ACK`` lines are of the form:

96 97 98
.. code-block:: none

 ACK [error@command_listNum] {current_command} message_text
99 100 101 102 103 104 105 106 107

These responses are generated by a call to
``commandError``. They contain four separate
terms. Let's look at each of them:

- ``error``: numeric value of one
  of the ``ACK_ERROR`` constants defined
  in `src/protocol/Ack.hxx`.

108 109 110
- ``command_listNum``: offset of the command that caused the error in
  a :ref:`Command List <command_lists>`.  An error will always cause a
  command list to terminate at the command that causes the error.
111

112 113
- ``current_command``: name of the command, in a :ref:`Command List
  <command_lists>`, that was executing when the error occurred.
114 115 116 117 118

- ``message_text``:
  some (hopefully) informative text that describes the
  nature of the error.

119 120
An example might help.  Consider the following sequence
sent from the client to the server::
121

122 123 124 125 126
 command_list_begin
 volume 86
 play 10240
 status
 command_list_end
127

128
The server responds with::
129

130
 ACK [50@1] {play} song doesn't exist: "10240"
131

132 133 134 135 136
This tells us that the play command, which was the second in the list
(the first or only command is numbered 0), failed with error 50.  The
number 50 translates to ``ACK_ERROR_NO_EXIST`` -- the song doesn't
exist.  This is reiterated by the message text which also tells us
which song doesn't exist.
137 138 139 140 141 142 143 144 145 146 147 148

.. _command_lists:

Command lists
=============

To facilitate faster adding of files etc. you can pass a list
of commands all at once using a command list.  The command
list begins with `command_list_begin` or
`command_list_ok_begin` and ends with
`command_list_end`.

149 150 151
It does not execute any commands until the list has ended.  The
response is a concatentation of all individual responses.
On success for all commands,
152 153 154 155 156 157 158 159 160 161
``OK`` is returned.  If a command
fails, no more commands are executed and the appropriate
``ACK`` error is returned. If
`command_list_ok_begin` is used,
``list_OK`` is returned for each
successful command executed in the command list.

Ranges
======

162 163 164 165
Some commands (e.g. :ref:`delete <command_delete>`) allow specifying a
range in the form ``START:END`` (the ``END`` item is not included in
the range, similar to ranges in the Python programming language).  If
``END`` is omitted, then the maximum possible value is assumed.
166 167 168 169 170 171

.. _filter_syntax:

Filters
=======

172 173 174
All commands which search for songs (e.g. :ref:`find <command_find>`
and :ref:`searchadd <command_searchadd>`) share a common filter
syntax::
175

176
 find EXPRESSION
177

178
``EXPRESSION`` is a string enclosed in parentheses which can be one
179
of:
180

181 182 183 184
- ``(TAG == 'VALUE')``: match a tag value; if there are multiple
  values of the given type, at least one must match.
  ``(TAG != 'VALUE')``: mismatch a tag value; if there are multiple
  values of the given type, none of them must match.
185
  The special tag ``any`` checks all
186
  tag types.
187
  ``AlbumArtist`` looks for
188 189 190
  ``VALUE`` in ``AlbumArtist``
  and falls back to ``Artist`` tags if
  ``AlbumArtist`` does not exist.
191
  ``VALUE`` is what to find.
192 193 194
  An empty value string means: match only if the given tag type does
  not exist at all; this implies that negation with an empty value
  checks for the existence of the given tag type.
195

196 197 198
- ``(TAG contains 'VALUE')`` checks if the given value is a substring
  of the tag value.

199 200 201 202 203
- ``(TAG =~ 'VALUE')`` and ``(TAG !~ 'VALUE')`` use a Perl-compatible
  regular expression instead of doing a simple string comparison.
  (This feature is only available if :program:`MPD` was compiled with
  :file:`libpcre`)

204 205 206 207 208 209 210 211 212 213 214
- ``(file == 'VALUE')``: match the full song URI
  (relative to the music directory).

- ``(base 'VALUE')``: restrict the search to
  songs in the given directory (relative to the music
  directory).

- ``(modified-since 'VALUE')``: compares the
  file's time stamp with the given value (ISO 8601 or UNIX
  time stamp).

215 216 217
- ``(AudioFormat == 'SAMPLERATE:BITS:CHANNELS')``: compares the audio
  format with the given value.  See :ref:`audio_output_format` for a
  detailed explanation.
218 219 220

- ``(AudioFormat =~ 'SAMPLERATE:BITS:CHANNELS')``:
  matches the audio format with the given mask (i.e. one
221
  or more attributes may be ``*``).
222

223
- ``(!EXPRESSION)``: negate an expression.  Note that each expression
224
  must be enclosed in parentheses, e.g. :code:`(!(artist == 'VALUE'))`
225
  (which is equivalent to :code:`(artist != 'VALUE')`)
226 227

- ``(EXPRESSION1 AND EXPRESSION2 ...)``: combine two or
228
  more expressions with logical "and".  Note that each expression must
229
  be enclosed in parentheses, e.g. :code:`((artist == 'FOO') AND
230
  (album == 'BAR'))`
231

Xipmix's avatar
Xipmix committed
232
The :command:`find` commands are case sensitive, while
233 234
:command:`search` and related commands ignore case.

235
Prior to MPD 0.21, the syntax looked like this::
236

237
 find TYPE VALUE
238

239 240 241 242 243 244 245 246 247 248 249
Escaping String Values
----------------------

String values are quoted with single or double quotes, and special
characters within those values must be escaped with the backslash
(``\``).  Keep in mind that the backslash is also the escape character
on the protocol level, which means you may need to use double
backslash.

Example expression which matches an artist named ``foo'bar"``::

250
 (Artist == "foo\'bar\"")
251 252 253

At the protocol level, the command must look like this::

254
 find "(Artist == \"foo\\'bar\\\"\")"
255 256 257 258 259 260 261 262 263 264 265 266 267 268

The double quotes enclosing the artist name must be escaped because
they are inside a double-quoted ``find`` parameter.  The single quote
inside that artist name must be escaped with two backslashes; one to
escape the single quote, and another one because the backslash inside
the string inside the parameter needs to be escaped as well.  The
double quote has three confusing backslashes: two to build one
backslash, and another one to escape the double quote on the protocol
level.  Phew!

To reduce confusion, you should use a library such as `libmpdclient
<https://www.musicpd.org/libs/libmpdclient/>`_ which escapes command
arguments for you.

269 270 271 272 273
.. _tags:

Tags
====

274
The following tags are supported by :program:`MPD`:
275

276 277 278 279 280 281 282 283 284 285 286
* **artist**: the artist name. Its meaning is not well-defined; see "*composer*" and "*performer*" for more specific tags.
* **artistsort**: same as artist, but for sorting. This usually omits prefixes such as "The".
* **album**: the album name.
* **albumsort**: same as album, but for sorting.
* **albumartist**: on multi-artist albums, this is the artist name which shall be used for the whole album. The exact meaning of this tag is not well-defined.
* **albumartistsort**: same as albumartist, but for sorting.
* **title**: the song title.
* **track**: the decimal track number within the album.
* **name**: a name for this song. This is not the song title. The exact meaning of this tag is not well-defined. It is often used by badly configured internet radio stations with broken tags to squeeze both the artist name and the song title in one tag.
* **genre**: the music genre.
* **date**: the song's release date. This is usually a 4-digit year.
287
* **originaldate**: the song's original release date.
288 289
* **composer**: the artist who composed the song.
* **performer**: the artist who performed the song.
smutbert's avatar
smutbert committed
290
* **conductor**: the conductor who conducted the song.
291 292
* **work**: `"a work is a distinct intellectual or artistic creation,
  which can be expressed in the form of one or more audio recordings" <https://musicbrainz.org/doc/Work>`_
293 294 295
* **grouping**: "used if the sound belongs to a larger category of
  sounds/music" (`from the IDv2.4.0 TIT1 description
  <http://id3.org/id3v2.4.0-frames>`_).
296 297
* **comment**: a human-readable comment about this song. The exact meaning of this tag is not well-defined.
* **disc**: the decimal disc number in a multi-disc album.
298
* **label**: the name of the label or publisher.
299 300 301 302 303 304 305
* **musicbrainz_artistid**: the artist id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
* **musicbrainz_albumid**: the album id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
* **musicbrainz_albumartistid**: the album artist id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
* **musicbrainz_trackid**: the track id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
* **musicbrainz_releasetrackid**: the release track id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.
* **musicbrainz_workid**: the work id in the `MusicBrainz <https://picard.musicbrainz.org/docs/mappings/>`_ database.

306
There can be multiple values for some of these tags.  For
307
example, :program:`MPD` may return multiple
308 309 310 311 312 313 314 315
lines with a ``performer`` tag.  A tag value is
a UTF-8 string.

.. _other_metadata:

Other Metadata
==============

316 317
The response to :ref:`lsinfo <command_lsinfo>` and similar commands
may contain :ref:`song tags <tags>` and other metadata, specifically:
318 319 320 321 322 323 324 325

- ``duration``: the duration of the song in
  seconds; may contain a fractional part.

- ``time``: like ``duration``,
  but as integer value.  This is deprecated and is only here
  for compatibility with older clients.  Do not use.

326 327 328 329 330 331
- ``Range``: if this is a queue item referring only to a portion of
  the song file, then this attribute contains the time range in the
  form ``START-END`` or ``START-`` (open ended); both ``START`` and
  ``END`` are time stamps within the song in seconds (may contain a
  fractional part).  Example: ``60-120`` plays only the second minute;
  "``180`` skips the first three minutes.
332 333 334 335

- ``Format``: the audio format of the song
  (or an approximation to a format supported by MPD and the
  decoder plugin being used).  When playing this file, the
336
  ``audio`` value in the :ref:`status <command_status>`
337 338 339 340 341 342 343 344
  response should be the same.

- ``Last-Modified``: the time stamp of the
  last modification of the underlying file in ISO 8601
  format.  Example:
  "*2008-09-28T20:04:57Z*"

Recipes
345
*******
346 347 348 349

Queuing
=======

350 351 352
Often, users run :program:`MPD` with :ref:`random <command_random>`
enabled, but want to be able to insert songs "before" the rest of the
playlist.  That is commonly called "queuing".
353

354 355 356 357 358
:program:`MPD` implements this by allowing the client to specify a
"priority" for each song in the playlist (commands :ref:`priod
<command_prio>` and :ref:`priodid <command_prioid>`).  A higher
priority means that the song is going to be played before the other
songs.
359

360
In "random" mode, :program:`MPD` maintains an
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
internal randomized sequence of songs.  In this sequence,
songs with a higher priority come first, and all songs with
the same priority are shuffled (by default, all songs are
shuffled, because all have the same priority "0").  When you
increase the priority of a song, it is moved to the front of
the sequence according to its new priority, but always after
the current one.  A song that has been played already (it's
"before" the current song in that sequence) will only be
scheduled for repeated playback if its priority has become
bigger than the priority of the current song.  Decreasing the
priority of a song will move it farther to the end of the
sequence.  Changing the priority of the current song has no
effect on the sequence.  During playback, a song's priority is
reset to zero.

Command reference
377
*****************
378 379 380 381 382 383 384

.. note:: For manipulating playlists and playing, there are two sets of
   commands.  One set uses the song id of a song in the playlist,
   while another set uses the playlist position of the song. The
   commands using song ids should be used instead of the commands
   that manipulate and control playback based on playlist
   position. Using song ids is a safer method when multiple
385
   clients are interacting with :program:`MPD`.
386

387
Querying :program:`MPD`'s status
388 389
================================

390 391
.. _command_clearerror:

392
:command:`clearerror`
393 394 395
    Clears the current error message in status (this is also
    accomplished by any command that starts playback).

396 397
.. _command_currentsong:

398
:command:`currentsong`
399
    Displays the song info of the current song (same song that
400 401 402
    is identified in status). Information about the current song
    is represented by key-value pairs, one on each line. The first
    pair must be the `file` key-value pair.
403

404 405 406
.. _command_idle:

:command:`idle [SUBSYSTEMS...]` [#since_0_14]_
407
    Waits until there is a noteworthy change in one or more
408
    of :program:`MPD`'s subsystems.  As soon
409 410 411 412
    as there is one, it lists all changed systems in a line
    in the format ``changed:
    SUBSYSTEM``, where SUBSYSTEM is one of the
    following:
413 414

    - ``database``: the song database has been modified after :ref:`update <command_update>`.
415 416
    - ``update``: a database update has started or finished.  If the database was modified during the update, the ``database`` event is also emitted.
    - ``stored_playlist``: a stored playlist has been modified, renamed, created or deleted
417
    - ``playlist``: the queue (i.e. the current playlist) has been modified
418 419 420
    - ``player``: the player has been started, stopped or seeked or
      tags of the currently playing song have changed (e.g. received
      from stream)
421 422 423 424 425 426 427
    - ``mixer``: the volume has been changed
    - ``output``: an audio output has been added, removed or modified (e.g. renamed, enabled or disabled)
    - ``options``: options like repeat, random, crossfade, replay gain
    - ``partition``: a partition was added, removed or changed
    - ``sticker``: the sticker database has been modified.
    - ``subscription``: a client has subscribed or unsubscribed to a channel
    - ``message``: a message was received on a channel this client is subscribed to; this event is only emitted when the queue is empty
428 429
    - ``neighbor``: a neighbor was found or lost
    - ``mount``: the mount list has changed
430 431

    Change events accumulate, even while the connection is not in
432
    "idle" mode; no events get lost while the client is doing
433 434
    something else with the connection.  If an event had already
    occurred since the last call, the new :ref:`idle <command_idle>`
435
    command will return immediately.
436

437 438 439 440 441
    While a client is waiting for `idle`
    results, the server disables timeouts, allowing a client
    to wait for events as long as mpd runs.  The
    `idle` command can be canceled by
    sending the command `noidle` (no other
442
    commands are allowed). :program:`MPD`
443 444 445
    will then leave `idle` mode and print
    results immediately; might be empty at this time.
    If the optional ``SUBSYSTEMS`` argument
446
    is used, :program:`MPD` will only send
447 448 449
    notifications when something changed in one of the
    specified subsytems.

450 451 452
.. _command_status:

:command:`status`
453 454
    Reports the current status of the player and the volume
    level.
455

456 457
    - ``partition``: the name of the current partition (see
      :ref:`partition_commands`)
458 459
    - ``volume``: ``0-100`` (deprecated: ``-1`` if the volume cannot
      be determined)
460 461
    - ``repeat``: ``0`` or ``1``
    - ``random``: ``0`` or ``1``
462
    - ``single`` [#since_0_15]_: ``0``, ``1``, or ``oneshot`` [#since_0_21]_
463
    - ``consume`` [#since_0_15]_: ``0`` or ``1``
464 465
    - ``playlist``: 31-bit unsigned integer, the playlist version number
    - ``playlistlength``: integer, the length of the playlist
466
    - ``state``: ``play``, ``stop``, or ``pause``
467 468
    - ``song``: playlist song number of the current song stopped on or playing
    - ``songid``: playlist songid of the current song stopped on or playing
469 470
    - ``nextsong`` [#since_0_15]_: playlist song number of the next song to be played
    - ``nextsongid`` [#since_0_15]_: playlist songid of the next song to be played
471
    - ``time``: total time elapsed (of current playing/paused song) in seconds
472
      (deprecated, use ``elapsed`` instead)
473 474
    - ``elapsed`` [#since_0_16]_: Total time elapsed within the
      current song in seconds, but with higher resolution.
475
    - ``duration`` [#since_0_20]_: Duration of the current song in seconds.
476 477 478 479
    - ``bitrate``: instantaneous bitrate in kbps
    - ``xfade``: ``crossfade`` in seconds
    - ``mixrampdb``: ``mixramp`` threshold in dB
    - ``mixrampdelay``: ``mixrampdelay`` in seconds
480 481 482
    - ``audio``: The format emitted by the decoder plugin during
      playback, format: ``samplerate:bits:channels``.  See
      :ref:`audio_output_format` for a detailed explanation.
483 484 485
    - ``updating_db``: ``job id``
    - ``error``: if there is an error, returns message here

486 487 488 489
    :program:`MPD` may omit lines which have no (known) value.  Older
    :program:`MPD` versions used to have a "magic" value for
    "unknown", e.g. ":samp:`volume: -1`".

490 491
.. _command_stats:

492
:command:`stats`
493
    Displays statistics.
494

495 496 497 498
    - ``artists``: number of artists
    - ``albums``: number of albums
    - ``songs``: number of songs
    - ``uptime``: daemon uptime in seconds
499
    - ``db_playtime``: sum of all song times in the database in seconds
500 501
    - ``db_update``: last db update in UNIX time (seconds since
      1970-01-01 UTC)
502 503 504 505 506
    - ``playtime``: time length of music played

Playback options
================

507 508
.. _command_consume:

509
:command:`consume {STATE}` [#since_0_15]_
510 511 512 513
    Sets consume state to ``STATE``,
    ``STATE`` should be 0 or 1.
    When consume is activated, each song played is removed from playlist.

514 515
.. _command_crossfade:

516
:command:`crossfade {SECONDS}`
517 518
    Sets crossfading between songs.

519 520
.. _command_mixrampdb:

521
:command:`mixrampdb {deciBels}`
522 523
    Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags crossfading will be used. See http://sourceforge.net/projects/mixramp

524 525
.. _command_mixrampdelay:

526
:command:`mixrampdelay {SECONDS}`
527 528
    Additional time subtracted from the overlap calculated by mixrampdb. A value of "nan" disables MixRamp overlapping and falls back to crossfading.

529 530 531
.. _command_random:

:command:`random {STATE}`
532 533 534
    Sets random state to ``STATE``,
    ``STATE`` should be 0 or 1.

535 536
.. _command_repeat:

537
:command:`repeat {STATE}`
538 539 540
    Sets repeat state to ``STATE``,
    ``STATE`` should be 0 or 1.

541 542 543
.. _command_setvol:

:command:`setvol {VOL}`
544 545 546
    Sets volume to ``VOL``, the range of
    volume is 0-100.

547 548
.. _command_single:

549
:command:`single {STATE}` [#since_0_15]_
550
    Sets single state to ``STATE``,
551
    ``STATE`` should be ``0``, ``1`` or ``oneshot`` [#since_0_21]_.
552 553 554
    When single is activated, playback is stopped after current song, or
    song is repeated if the 'repeat' mode is enabled.

555 556
.. _command_replay_gain_mode:

557
:command:`replay_gain_mode {MODE}` [#since_0_16]_
558
    Sets the replay gain mode.  One of
559 560 561 562
    ``off``,
    ``track``,
    ``album``,
    ``auto``
563 564
    .
    Changing the mode during playback may take several
565
    seconds, because the new settings do not affect the
566 567 568 569
    buffered data.
    This command triggers the
    ``options`` idle event.

570 571
.. _command_replay_gain_status:

572
:command:`replay_gain_status`
573 574 575 576
    Prints replay gain options.  Currently, only the
    variable ``replay_gain_mode`` is
    returned.

577 578
.. _command_volume:

579
:command:`volume {CHANGE}`
580
    Changes volume by amount ``CHANGE``.
581
    Deprecated, use :ref:`setvol <command_setvol>` instead.
582 583 584 585

Controlling playback
====================

586 587
.. _command_next:

588
:command:`next`
589 590
    Plays next song in the playlist.

591 592
.. _command_pause:

593 594 595 596
:command:`pause {STATE}`
    Pause or resume playback.  Pass :samp:`1` to pause playback or
    :samp:`0` to resume playback.  Without the parameter, the pause
    state is toggled.
597

598 599
.. _command_play:

600
:command:`play [SONGPOS]`
601 602 603
    Begins playing the playlist at song number
    ``SONGPOS``.

604 605
.. _command_playid:

606
:command:`playid [SONGID]`
607 608 609
    Begins playing the playlist at song
    ``SONGID``.

610 611
.. _command_previous:

612
:command:`previous`
613 614
    Plays previous song in the playlist.

615 616
.. _command_seek:

617
:command:`seek {SONGPOS} {TIME}`
618 619 620 621
    Seeks to the position ``TIME`` (in
    seconds; fractions allowed) of entry
    ``SONGPOS`` in the playlist.

622 623
.. _command_seekid:

624
:command:`seekid {SONGID} {TIME}`
625 626 627 628
    Seeks to the position ``TIME`` (in
    seconds; fractions allowed) of song
    ``SONGID``.

629 630
.. _command_seekcur:

631
:command:`seekcur {TIME}`
632 633
    Seeks to the position ``TIME`` (in
    seconds; fractions allowed) within the current song.  If
634
    prefixed by ``+`` or ``-``, then the time is relative to the
635 636
    current playing position.

637 638
.. _command_stop:

639
:command:`stop`
640 641
    Stops playing.

642 643 644 645 646 647 648 649 650 651 652 653 654 655
The Queue
=========

.. note:: The "queue" used to be called "current playlist" or just
          "playlist", but that was deemed confusing, because
          "playlists" are also files containing a sequence of songs.
          Those "playlist files" or "stored playlists" can be
          :ref:`loaded into the queue <command_load>` and the queue
          can be :ref:`saved into a playlist file <command_save>`, but
          they are not to be confused with the queue.

          Many of the command names in this section reflect the old
          naming convention, but for the sake of compatibility, we
          cannot rename commands.
656

657 658 659
There are two ways to address songs within the queue: by their
position and by their id.

660
The position is a 0-based index.  It is unstable by design: if you
661 662 663 664 665 666 667 668 669 670 671 672
move, delete or insert songs, all following indices will change, and a
client can never be sure what song is behind a given index/position.

Song ids on the other hand are stable: an id is assigned to a song
when it is added, and will stay the same, no matter how much it is
moved around.  Adding the same song twice will assign different ids to
them, and a deleted-and-readded song will have a new id.  This way, a
client can always be sure the correct song is being used.

Many commands come in two flavors, one for each address type.
Whenever possible, ids should be used.

673 674
.. _command_add:

675
:command:`add {URI}`
676 677 678 679
    Adds the file ``URI`` to the playlist
    (directories add recursively). ``URI``
    can also be a single file.

680
    Clients that are connected via local socket may add arbitrary
681
    local files (URI is an absolute path).  Example::
682 683 684

     add "/home/foo/Music/bar.ogg"

685 686
.. _command_addid:

687 688 689
:command:`addid {URI} [POSITION]`
    Adds a song to the playlist (non-recursive) and returns the
    song id. ``URI`` is always a single file or  URL.  For example::
690

691 692 693
     addid "foo.mp3"
     Id: 999
     OK
694

695 696
.. _command_clear:

697
:command:`clear`
698
    Clears the queue.
699

700 701 702
.. _command_delete:

:command:`delete [{POS} | {START:END}]`
703 704
    Deletes a song from the playlist.

705 706
.. _command_deleteid:

707
:command:`deleteid {SONGID}`
708 709 710
    Deletes the song ``SONGID`` from the
    playlist

711 712
.. _command_move:

cotko's avatar
cotko committed
713
:command:`move [{FROM} | {START:END}] {TO}`
714
    Moves the song at ``FROM`` or range of songs
715
    at ``START:END`` [#since_0_15]_ to ``TO``
716 717
    in the playlist.

718 719
.. _command_moveid:

720
:command:`moveid {FROM} {TO}`
721 722 723 724 725 726
    Moves the song with ``FROM`` (songid) to
    ``TO`` (playlist index) in the
    playlist.  If ``TO`` is negative, it
    is relative to the current song in the playlist (if
    there is one).

727 728
.. _command_playlist:

729 730
:command:`playlist`

731
    Displays the queue.
732

733 734 735
    Do not use this, instead use :ref:`playlistinfo
    <command_playlistinfo>`.

736 737
.. _command_playlistfind:

738
:command:`playlistfind {FILTER}`
739
    Finds songs in the queue with strict
740 741
    matching.

742 743
.. _command_playlistid:

744
:command:`playlistid {SONGID}`
745 746 747 748
    Displays a list of songs in the playlist.
    ``SONGID`` is optional and specifies a
    single song to display info for.

749 750 751
.. _command_playlistinfo:

:command:`playlistinfo [[SONGPOS] | [START:END]]`
752 753 754
    Displays a list of all songs in the playlist, or if the optional
    argument is given, displays information only for the song
    ``SONGPOS`` or the range of songs
755
    ``START:END`` [#since_0_15]_
756

757 758
.. _command_playlistsearch:

759
:command:`playlistsearch {FILTER}`
760
    Searches case-insensitively for partial matches in the
761
    queue.
762

763 764
.. _command_plchanges:

765
:command:`plchanges {VERSION} [START:END]`
766 767 768 769
    Displays changed songs currently in the playlist since
    ``VERSION``.  Start and end positions may
    be given to limit the output to changes in the given
    range.
770

771 772 773
    To detect songs that were deleted at the end of the
    playlist, use playlistlength returned by status command.

774 775
.. _command_plchangesposid:

776
:command:`plchangesposid {VERSION} [START:END]`
777 778 779 780
    Displays changed songs currently in the playlist since
    ``VERSION``.  This function only
    returns the position and the id of the changed song, not
    the complete metadata. This is more bandwidth efficient.
781

782 783 784
    To detect songs that were deleted at the end of the
    playlist, use playlistlength returned by status command.

785 786 787
.. _command_prio:

:command:`prio {PRIORITY} {START:END...}`
788 789 790
    Set the priority of the specified songs.  A higher
    priority means that it will be played first when
    "random" mode is enabled.
791

792 793 794
    A priority is an integer between 0 and 255.  The default
    priority of new songs is 0.

795 796 797 798
.. _command_prioid:

:command:`prioid {PRIORITY} {ID...}`
    Same as :ref:`priod <command_prio>`,
799 800
    but address the songs with their id.

801 802
.. _command_rangeid:

803
:command:`rangeid {ID} {START:END}` [#since_0_19]_
804
    Since :program:`MPD`
805 806 807 808 809 810 811 812
    0.19 Specifies the portion of the
    song that shall be played.  ``START`` and
    ``END`` are offsets in seconds
    (fractional seconds allowed); both are optional.
    Omitting both (i.e. sending just ":") means "remove the
    range, play everything".  A song that is currently
    playing cannot be manipulated this way.

813 814
.. _command_shuffle:

815
:command:`shuffle [START:END]`
816
    Shuffles the queue.
817 818 819
    ``START:END`` is optional and specifies
    a range of songs.

820 821
.. _command_swap:

822
:command:`swap {SONG1} {SONG2}`
823 824 825
    Swaps the positions of ``SONG1`` and
    ``SONG2``.

826 827
.. _command_swapid:

828
:command:`swapid {SONG1} {SONG2}`
829 830 831
    Swaps the positions of ``SONG1`` and
    ``SONG2`` (both song ids).

832 833
.. _command_addtagid:

834
:command:`addtagid {SONGID} {TAG} {VALUE}`
835 836 837 838 839 840
    Adds a tag to the specified song.  Editing song tags is
    only possible for remote songs.  This change is
    volatile: it may be overwritten by tags received from
    the server, and the data is gone when the song gets
    removed from the queue.

841 842
.. _command_cleartagid:

843
:command:`cleartagid {SONGID} [TAG]`
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
    Removes tags from the specified song.  If
    ``TAG`` is not specified, then all tag
    values will be removed.  Editing song tags is only
    possible for remote songs.

Stored playlists
================

Playlists are stored inside the configured playlist directory.
They are addressed with their file name (without the directory
and without the `.m3u` suffix).

Some of the commands described in this section can be used to
run playlist plugins instead of the hard-coded simple
`m3u` parser.  They can access playlists in
859 860
the music directory (relative path including the suffix),
playlists in arbitrary location (absolute path including the suffix;
861
allowed only for clients that are connected via local socket), or
862 863
remote playlists (absolute URI with a supported scheme).

864 865
.. _command_listplaylist:

866
:command:`listplaylist {NAME}`
867 868 869
    Lists the songs in the playlist.  Playlist plugins are
    supported.

870 871
.. _command_listplaylistinfo:

872
:command:`listplaylistinfo {NAME}`
873 874 875
    Lists the songs with metadata in the playlist.  Playlist
    plugins are supported.

876 877
.. _command_listplaylists:

878
:command:`listplaylists`
879 880 881 882 883 884 885
    Prints a list of the playlist directory.
    After each playlist name the server sends its last
    modification time as attribute "Last-Modified" in ISO
    8601 format.  To avoid problems due to clock differences
    between clients and the server, clients should not
    compare this value with their local clock.

886 887
.. _command_load:

888
:command:`load {NAME} [START:END]`
889 890 891 892
    Loads the playlist into the current queue.  Playlist
    plugins are supported.  A range may be specified to load
    only a part of the playlist.

893 894
.. _command_playlistadd:

895
:command:`playlistadd {NAME} {URI}`
896 897 898 899 900
    Adds ``URI`` to the playlist
    `NAME.m3u`.
    `NAME.m3u` will be created if it does
    not exist.

901 902
.. _command_playlistclear:

903
:command:`playlistclear {NAME}`
904 905
    Clears the playlist `NAME.m3u`.

906 907
.. _command_playlistdelete:

908
:command:`playlistdelete {NAME} {SONGPOS}`
909 910 911
    Deletes ``SONGPOS`` from the
    playlist `NAME.m3u`.

912 913
.. _command_playlistmove:

914
:command:`playlistmove {NAME} {FROM} {TO}`
915 916 917 918
    Moves the song at position ``FROM`` in
    the playlist `NAME.m3u` to the
    position ``TO``.

919 920
.. _command_rename:

921
:command:`rename {NAME} {NEW_NAME}`
922 923
    Renames the playlist `NAME.m3u` to `NEW_NAME.m3u`.

924 925
.. _command_rm:

926
:command:`rm {NAME}`
927 928 929
    Removes the playlist `NAME.m3u` from
    the playlist directory.

930 931
.. _command_save:

932
:command:`save {NAME}`
933
    Saves the queue to
934 935 936 937 938
    `NAME.m3u` in the playlist directory.

The music database
==================

939 940
.. _command_albumart:

941
:command:`albumart {URI} {OFFSET}`
942
    Locate album art for the given song and return a chunk of an album
943
    art image file at offset ``OFFSET``.
944 945 946 947

    This is currently implemented by searching the directory the file
    resides in for a file called :file:`cover.png`, :file:`cover.jpg`,
    :file:`cover.tiff` or :file:`cover.bmp`.
948

949 950
    Returns the file size and actual number
    of bytes read at the requested offset, followed
951
    by the chunk requested as raw bytes (see :ref:`binary`), then a
952
    newline and the completion code.
953 954 955

    Example::

956
     albumart foo/bar.ogg 0
957 958
     size: 1024768
     binary: 8192
959 960
     <8192 bytes>
     OK
961

962 963
.. _command_count:

964
:command:`count {FILTER} [group {GROUPTYPE}]`
965 966
    Count the number of songs and their total playtime in
    the database matching ``FILTER`` (see
967
    :ref:`Filters <filter_syntax>`).  The
968
    following prints the number of songs whose title matches
969 970 971 972
    "Echoes"::

     count title Echoes

973 974 975 976
    The *group* keyword may be used to
    group the results by a tag.  The first following example
    prints per-artist counts while the next prints the
    number of songs whose title matches "Echoes" grouped by
977 978 979 980
    artist::

     count group artist
     count title Echoes group artist
981

982 983
    A group with an empty value contains counts of matching songs which
    don't have this group tag.  It exists only if at least one such song is
984 985
    found.

986 987
.. _command_getfingerprint:

988 989 990 991 992 993 994 995 996 997 998
:command:`getfingerprint {URI}`

    Calculate the song's audio fingerprint.  Example (abbreviated fingerprint)::

      getfingerprint "foo/bar.ogg"
      chromaprint: AQACcEmSREmWJJmkIT_6CCf64...
      OK

    This command is only available if MPD was built with
    :file:`libchromaprint` (``-Dchromaprint=enabled``).

999 1000 1001
.. _command_find:

:command:`find {FILTER} [sort {TYPE}] [window {START:END}]`
1002
    Search the database for songs matching
1003 1004
    ``FILTER`` (see :ref:`Filters <filter_syntax>`).

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    ``sort`` sorts the result by the
    specified tag.  The sort is descending if the tag is
    prefixed with a minus ('-').
    Without ``sort``, the
    order is undefined.  Only the first tag value will be
    used, if multiple of the same type exist.  To sort by
    "Artist", "Album" or "AlbumArtist", you should specify
    "ArtistSort", "AlbumSort" or "AlbumArtistSort" instead.
    These will automatically fall back to the former if
    "\*Sort" doesn't exist.  "AlbumArtist" falls back to just
    "Artist".  The type "Last-Modified" can sort by file
    modification time.
1017

1018 1019 1020 1021 1022
    ``window`` can be used to query only a
    portion of the real response.  The parameter is two
    zero-based record numbers; a start number and an end
    number.

1023 1024
.. _command_findadd:

1025
:command:`findadd {FILTER} [sort {TYPE}] [window {START:END}]`
1026
    Search the database for songs matching
1027
    ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to
1028
    the queue.  Parameters have the same meaning as for
1029
    :ref:`find <command_find>`.
1030

1031 1032 1033
.. _command_list:

:command:`list {TYPE} {FILTER} [group {GROUPTYPE}]`
1034 1035
    Lists unique tags values of the specified type.
    ``TYPE`` can be any tag supported by
1036
    :program:`MPD`.
1037 1038

    Additional arguments may specify a :ref:`filter <filter_syntax>`.
1039 1040
    The *group* keyword may be used
    (repeatedly) to group the results by one or more tags.
1041

1042
    The following example lists all album names,
1043 1044 1045 1046
    grouped by their respective (album) artist::

     list album group albumartist

1047 1048 1049 1050
    ``list file`` was implemented in an early :program:`MPD` version,
    but does not appear to make a lot of sense.  It still works (to
    avoid breaking compatibility), but is deprecated.

1051
.. _command_listall:
1052

1053
:command:`listall [URI]`
1054 1055
    Lists all songs and directories in
    ``URI``.
1056

1057
    Do not use this command.  Do not manage a client-side
1058
    copy of :program:`MPD`'s database.  That
1059 1060
    is fragile and adds huge overhead.  It will break with
    large databases.  Instead, query
1061
    :program:`MPD` whenever you need
1062 1063
    something.

1064 1065 1066 1067
.. _command_listallinfo:

:command:`listallinfo [URI]`
    Same as :ref:`listall <command_listall>`,
1068
    except it also returns metadata info in the same format
1069 1070
    as :ref:`lsinfo <command_lsinfo>`

1071
    Do not use this command.  Do not manage a client-side
1072
    copy of :program:`MPD`'s database.  That
1073 1074
    is fragile and adds huge overhead.  It will break with
    large databases.  Instead, query
1075
    :program:`MPD` whenever you need
1076 1077
    something.

1078 1079
.. _command_listfiles:

1080
:command:`listfiles {URI}`
1081 1082
    Lists the contents of the directory
    ``URI``, including files are not
1083
    recognized by :program:`MPD`.
1084 1085 1086 1087 1088 1089
    ``URI`` can be a path relative to the
    music directory or an URI understood by one of the
    storage plugins.  The response contains at least one
    line for each directory entry with the prefix "file: "
    or "directory: ", and may be followed by file attributes
    such as "Last-Modified" and "size".
1090

1091 1092 1093 1094
    For example, "smb://SERVER" returns a list of all shares
    on the given SMB/CIFS server; "nfs://servername/path"
    obtains a directory listing from the NFS server.

1095 1096
.. _command_lsinfo:

kaliko's avatar
kaliko committed
1097
:command:`lsinfo [URI]`
1098 1099 1100 1101 1102
    Lists the contents of the directory
    ``URI``.  The response contains records
    starting with ``file``,
    ``directory`` or
    ``playlist``, each followed by metadata
1103 1104
    (:ref:`tags <tags>` or :ref:`other metadata <other_metadata>`).

1105 1106 1107
    When listing the root directory, this currently returns
    the list of stored playlists.  This behavior is
    deprecated; use "listplaylists" instead.
1108

1109 1110
    This command may be used to list metadata of remote
    files (e.g. URI beginning with "http://" or "smb://").
1111

1112
    Clients that are connected via local socket may
1113 1114 1115
    use this command to read the tags of an arbitrary local
    file (URI is an absolute path).

1116 1117
.. _command_readcomments:

1118
:command:`readcomments {URI}`
1119 1120 1121
    Read "comments" (i.e. key-value pairs) from the file
    specified by "URI".  This "URI" can be a path relative
    to the music directory or an absolute path.
1122

1123 1124
    This command may be used to list metadata of remote
    files (e.g. URI beginning with "http://" or "smb://").
1125

1126 1127 1128
    The response consists of lines in the form "KEY: VALUE".
    Comments with suspicious characters (e.g. newlines) are
    ignored silently.
1129

1130 1131 1132 1133
    The meaning of these depends on the codec, and not all
    decoder plugins support it.  For example, on Ogg files,
    this lists the Vorbis comments.

1134 1135
.. _command_readpicture:

1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
:command:`readpicture {URI} {OFFSET}`
    Locate a picture for the given song and return a chunk of the
    image file at offset ``OFFSET``.  This is usually implemented by
    reading embedded pictures from binary tags (e.g. ID3v2's ``APIC``
    tag).

    Returns the following values:

    - ``size``: the total file size
    - ``type``: the file's MIME type (optional)
    - ``binary``: see :ref:`binary`

    If the song file was recognized, but there is no picture, the
    response is successful, but is otherwise empty.

    Example::

     readpicture foo/bar.ogg 0
     size: 1024768
     type: image/jpeg
     binary: 8192
     <8192 bytes>
     OK

1160 1161 1162
.. _command_search:

:command:`search {FILTER} [sort {TYPE}] [window {START:END}]`
1163
    Search the database for songs matching
1164 1165
    ``FILTER`` (see :ref:`Filters <filter_syntax>`).  Parameters
    have the same meaning as for :ref:`find <command_find>`,
1166 1167
    except that search is not case sensitive.

1168 1169
.. _command_searchadd:

1170
:command:`searchadd {FILTER} [sort {TYPE}] [window {START:END}]`
1171
    Search the database for songs matching
1172
    ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to
1173 1174
    the queue.

1175 1176
    Parameters have the same meaning as for :ref:`search <command_search>`.

1177 1178
.. _command_searchaddpl:

1179
:command:`searchaddpl {NAME} {FILTER} [sort {TYPE}] [window {START:END}]`
1180
    Search the database for songs matching
1181
    ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to
1182
    the playlist named ``NAME``.
1183

1184 1185
    If a playlist by that name doesn't exist it is created.

1186 1187 1188 1189 1190
    Parameters have the same meaning as for :ref:`search <command_search>`.

.. _command_update:

:command:`update [URI]`
1191 1192
    Updates the music database: find new files, remove
    deleted files, update modified files.
1193

1194 1195 1196
    ``URI`` is a particular directory or
    song/file to update.  If you do not specify it,
    everything is updated.
1197 1198

    Prints ``updating_db: JOBID`` where
1199 1200
    ``JOBID`` is a positive number
    identifying the update job.  You can read the current
1201
    job id in the :ref:`status <command_status>`
1202 1203
    response.

1204 1205
.. _command_rescan:

1206 1207
:command:`rescan [URI]`
    Same as :ref:`update <command_update>`,
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
    but also rescans unmodified files.

Mounts and neighbors
====================

A "storage" provides access to files in a directory tree.  The
most basic storage plugin is the "local" storage plugin which
accesses the local file system, and there are plugins to
access NFS and SMB servers.

Multiple storages can be "mounted" together, similar to the
`mount` command on many operating
systems, but without cooperation from the kernel.  No
1221 1222
superuser privileges are necessary, because this mapping exists
only inside the :program:`MPD` process.
1223

1224 1225 1226
.. _command_mount:

:command:`mount {PATH} {URI}`
1227
    Mount the specified remote storage URI at the given
1228 1229 1230 1231
    path.  Example::

     mount foo nfs://192.168.1.4/export/mp3

1232 1233
.. _command_unmount:

1234 1235
:command:`unmount {PATH}`
    Unmounts the specified path.  Example::
1236

1237
     unmount foo
1238

1239 1240
.. _command_listmounts:

1241
:command:`listmounts`
1242 1243
    Queries a list of all mounts.  By default, this contains
    just the configured ``music_directory``.
1244 1245 1246 1247 1248 1249 1250 1251 1252
    Example::

     listmounts
     mount:
     storage: /home/foo/music
     mount: foo
     storage: nfs://192.168.1.4/export/mp3
     OK

1253 1254
.. _command_listneighbors:

1255
:command:`listneighbors`
1256 1257
    Queries a list of "neighbors" (e.g. accessible file
    servers on the local net).  Items on that list may be
1258 1259 1260 1261 1262 1263 1264
    used with the :ref:`mount <command_mount>`
    command.  Example::

     listneighbors
     neighbor: smb://FOO
     name: FOO (Samba 4.1.11-Debian)
     OK
1265 1266 1267 1268

Stickers
========

1269
"Stickers" [#since_0_15]_ are pieces of
1270
information attached to existing
1271
:program:`MPD` objects (e.g. song files,
1272 1273
directories, albums; but currently, they are only implemented for
song).  Clients can create arbitrary name/value
1274
pairs.  :program:`MPD` itself does not assume
1275 1276 1277 1278 1279
any special meaning in them.

The goal is to allow clients to share additional (possibly
dynamic) information about songs, which is neither stored on
the client (not available to other clients), nor stored in the
1280
song files (:program:`MPD` has no write
1281 1282 1283 1284 1285 1286 1287 1288 1289
access).

Client developers should create a standard for common sticker
names, to ensure interoperability.

Objects which may have stickers are addressed by their object
type ("song" for song objects) and their URI (the path within
the database for songs).

1290 1291
.. _command_sticker_get:

1292
:command:`sticker get {TYPE} {URI} {NAME}`
1293 1294
    Reads a sticker value for the specified object.

1295 1296
.. _command_sticker_set:

1297
:command:`sticker set {TYPE} {URI} {NAME} {VALUE}`
1298 1299 1300 1301
    Adds a sticker value to the specified object.  If a
    sticker item with that name already exists, it is
    replaced.

1302 1303
.. _command_sticker_delete:

1304
:command:`sticker delete {TYPE} {URI} [NAME]`
1305 1306 1307 1308
    Deletes a sticker value from the specified object.  If
    you do not specify a sticker name, all sticker values
    are deleted.

1309 1310
.. _command_sticker_list:

1311
:command:`sticker list {TYPE} {URI}`
1312 1313
    Lists the stickers for the specified object.

1314 1315
.. _command_sticker_find:

1316
:command:`sticker find {TYPE} {URI} {NAME}`
1317 1318 1319 1320 1321
    Searches the sticker database for stickers with the
    specified name, below the specified directory (URI).
    For each matching song, it prints the URI and that one
    sticker's value.

1322 1323
.. _command_sticker_find_value:

1324
:command:`sticker find {TYPE} {URI} {NAME} = {VALUE}`
1325
    Searches for stickers with the given value.
1326

1327 1328 1329 1330 1331 1332
    Other supported operators are:
    "``<``", "``>``"

Connection settings
===================

1333 1334
.. _command_close:

1335
:command:`close`
1336 1337
    Closes the connection to :program:`MPD`.
    :program:`MPD` will try to send the
1338 1339 1340 1341
    remaining output buffer before it actually closes the
    connection, but that cannot be guaranteed.  This command
    will not generate a response.

1342 1343 1344
    Clients should not use this command; instead, they should just
    close the socket.

1345 1346
.. _command_kill:

1347
:command:`kill`
1348
    Kills :program:`MPD`.
1349

1350 1351 1352 1353
    Do not use this command.  Send ``SIGTERM`` to :program:`MPD`
    instead, or better: let your service manager handle :program:`MPD`
    shutdown (e.g. :command:`systemctl stop mpd`).

1354 1355
.. _command_password:

1356
:command:`password {PASSWORD}`
1357 1358 1359 1360
    This is used for authentication with the server.
    ``PASSWORD`` is simply the plaintext
    password.

1361 1362
.. _command_ping:

1363
:command:`ping`
1364 1365
    Does nothing but return "OK".

1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
.. _command_binarylimit:

:command:`binarylimit SIZE` [#since_0_22_4]_

    Set the maximum :ref:`binary response <binary>` size for the
    current connection to the specified number of bytes.

    A bigger value means less overhead for transmitting large
    entities, but it also means that the connection is blocked for a
    longer time.

1377 1378
.. _command_tagtypes:

1379
:command:`tagtypes`
1380 1381 1382
    Shows a list of available tag types.  It is an
    intersection of the ``metadata_to_use``
    setting and this client's tag mask.
1383

1384 1385 1386 1387 1388 1389 1390
    About the tag mask: each client can decide to disable
    any number of tag types, which will be omitted from
    responses to this client.  That is a good idea, because
    it makes responses smaller.  The following
    ``tagtypes`` sub commands configure this
    list.

1391 1392
.. _command_tagtypes_disable:

kaliko's avatar
kaliko committed
1393
:command:`tagtypes disable {NAME...}`
1394 1395 1396 1397
    Remove one or more tags from the list of tag types the
    client is interested in.  These will be omitted from
    responses to this client.

1398 1399
.. _command_tagtypes_enable:

1400
:command:`tagtypes enable {NAME...}`
1401 1402 1403 1404
    Re-enable one or more tags from the list of tag types
    for this client.  These will no longer be hidden from
    responses to this client.

1405 1406
.. _command_tagtypes_clear:

1407
:command:`tagtypes clear`
1408
    Clear the list of tag types this client is interested
1409
    in.  This means that :program:`MPD` will
1410 1411
    not send any tags to this client.

1412 1413
.. _command_tagtypes_all:

1414
:command:`tagtypes all`
1415 1416 1417
    Announce that this client is interested in all tag
    types.  This is the default setting for new clients.

1418 1419
.. _partition_commands:

1420 1421 1422 1423 1424 1425 1426 1427
Partition commands
==================

These commands allow a client to inspect and manage
"partitions".  A partition is one frontend of a multi-player
MPD process: it has separate queue, player and outputs.  A
client is assigned to one partition at a time.

1428 1429
.. _command_partition:

1430
:command:`partition {NAME}`
1431 1432
    Switch the client to a different partition.

1433 1434
.. _command_listpartitions:

1435
:command:`listpartitions`
1436 1437 1438 1439 1440
    Print a list of partitions.  Each partition starts with
    a ``partition`` keyword and the
    partition's name, followed by information about the
    partition.

1441 1442
.. _command_newpartition:

1443
:command:`newpartition {NAME}`
1444 1445
    Create a new partition.

1446 1447
.. _command_delpartition:

1448 1449 1450 1451
:command:`delpartition {NAME}`
    Delete a partition.  The partition must be empty (no connected
    clients and no outputs).

1452 1453
.. _command_moveoutput:

1454 1455 1456
:command:`moveoutput {OUTPUTNAME}`
    Move an output to the current partition.

1457 1458 1459
Audio output devices
====================

1460 1461
.. _command_disableoutput:

1462
:command:`disableoutput {ID}`
1463 1464
    Turns an output off.

1465 1466
.. _command_enableoutput:

1467
:command:`enableoutput {ID}`
1468 1469
    Turns an output on.

1470 1471
.. _command_toggleoutput:

1472
:command:`toggleoutput {ID}`
1473 1474 1475
    Turns an output on or off, depending on the current
    state.

1476 1477 1478
.. _command_outputs:

:command:`outputs`
1479
    Shows information about all outputs.
1480

1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
    ::

        outputid: 0
        outputname: My ALSA Device
        plugin: alsa
        outputenabled: 0
        attribute: dop=0
        OK

    Return information:
1491

1492 1493 1494 1495
    - ``outputid``: ID of the output. May change between executions
    - ``outputname``: Name of the output. It can be any.
    - ``outputenabled``: Status of the output. 0 if disabled, 1 if enabled.

1496 1497
.. _command_outputset:

1498
:command:`outputset {ID} {NAME} {VALUE}`
1499 1500
    Set a runtime attribute.  These are specific to the
    output plugin, and supported values are usually printed
1501
    in the :ref:`outputs <command_outputs>`
1502 1503 1504 1505 1506
    response.

Reflection
==========

1507 1508
.. _command_config:

1509
:command:`config`
1510 1511
    Dumps configuration values that may be interesting for
    the client.  This command is only permitted to "local"
1512
    clients (connected via local socket).
1513

1514 1515
    The following response attributes are available:

1516 1517
    - ``music_directory``: The absolute path of the music directory.

1518 1519
.. _command_commands:

1520
:command:`commands`
1521 1522
    Shows which commands the current user has access to.

1523 1524
.. _command_notcommands:

1525
:command:`notcommands`
1526 1527 1528
    Shows which commands the current user does not have
    access to.

1529 1530
.. _command_urlhandlers:

1531
:command:`urlhandlers`
1532 1533
    Gets a list of available URL handlers.

1534 1535
.. _command_decoders:

1536
:command:`decoders`
1537
    Print a list of decoder plugins, followed by their
1538 1539 1540 1541 1542 1543 1544 1545
    supported suffixes and MIME types.  Example response::

     plugin: mad
     suffix: mp3
     suffix: mp2
     mime_type: audio/mpeg
     plugin: mpcdec
     suffix: mpc
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556

Client to client
================

Clients can communicate with each others over "channels".  A
channel is created by a client subscribing to it.  More than
one client can be subscribed to a channel at a time; all of
them will receive the messages which get sent to it.

Each time a client subscribes or unsubscribes, the global idle
event ``subscription`` is generated.  In
1557
conjunction with the :ref:`channels <command_channels>`
1558 1559 1560 1561 1562 1563
command, this may be used to auto-detect clients providing
additional services.

New messages are indicated by the ``message``
idle event.

1564 1565 1566
If your MPD instance has multiple partitions, note that
client-to-client messages are local to the current partition.

1567 1568
.. _command_subscribe:

1569
:command:`subscribe {NAME}`
1570 1571 1572 1573 1574
    Subscribe to a channel.  The channel is created if it
    does not exist already.  The name may consist of
    alphanumeric ASCII characters plus underscore, dash, dot
    and colon.

1575 1576
.. _command_unsubscribe:

1577
:command:`unsubscribe {NAME}`
1578 1579
    Unsubscribe from a channel.

1580 1581 1582
.. _command_channels:

:command:`channels`
1583 1584 1585
    Obtain a list of all channels.  The response is a list
    of "channel:" lines.

1586 1587
.. _command_readmessages:

1588
:command:`readmessages`
1589 1590 1591
    Reads messages for this client.  The response is a list
    of "channel:" and "message:" lines.

1592 1593
.. _command_sendmessage:

1594
:command:`sendmessage {CHANNEL} {TEXT}`
1595 1596
    Send a message to the specified channel.

1597
.. rubric:: Footnotes
1598

1599 1600 1601
.. [#since_0_14] Since :program:`MPD` 0.14
.. [#since_0_15] Since :program:`MPD` 0.15
.. [#since_0_16] Since :program:`MPD` 0.16
1602
.. [#since_0_19] Since :program:`MPD` 0.19
1603
.. [#since_0_20] Since :program:`MPD` 0.20
1604
.. [#since_0_21] Since :program:`MPD` 0.21
1605
.. [#since_0_22_4] Since :program:`MPD` 0.22.4