aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2008-10-14 22:38:14 +0200
committerMax Kellermann <max@duempel.org>2008-10-14 22:38:14 +0200
commita3e3d2c9506d17b3e19e205535ec263ee75178c9 (patch)
tree3e93ea6ae33dba8a8f5e12e34629366dcdd7fdb7 /doc
parent30c86d8ae64ae46ba3bcb1c63e867789feab6dc4 (diff)
command: added command "idle"
"idle" waits until something noteworthy happens on the server, e.g. song change, playlist modified, database updated. This allows clients to keep up to date without polling.
Diffstat (limited to 'doc')
-rw-r--r--doc/COMMANDS21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/COMMANDS b/doc/COMMANDS
index 19ad373b..718dcf24 100644
--- a/doc/COMMANDS
+++ b/doc/COMMANDS
@@ -265,6 +265,27 @@ volume <int change>
change volume by amount _change_
NOTE: volume command is deprecated, use setvol instead
+idle
+ 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 "changed: SUBSYSTEM",
+ where SUBSYSTEM is one of the following:
+
+ database: the song database has been updated
+ stored_playlist: a stored playlist has been modified, renamed,
+ created or deleted
+ playlist: the current playlist has been modified
+ player: the player has been started, stopped or seeked
+ mixer: the volume has been changed
+ output: an audio output has been enabled or disabled
+ options: options like "repeat", "random", "crossfade"
+
+ While a client waits 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 a new
+ command.
+
+
COMMAND LIST
------------