previous -> fetch_nothing
seek <int> <int> -> fetch_nothing
seekid <int> <int> -> fetch_nothing
+seekcur <int> -> fetch_nothing
stop -> fetch_nothing
-== Playlist Commands
+== Queue Commands
add <str> -> fetch_nothing
addid <str> [<int>] -> fetch_item
clear -> fetch_nothing
playlistsearch <locate> -> fetch_songs
plchanges <int> -> fetch_songs
plchangesposid <int> -> fetch_changes
-prio <int> <int>|<range> -> self._fetch_nothing,
-prioid <int> <int> -> self._fetch_nothing,
-rangeid <int> <range> -> self._fetch_nothing,
+prio <int> <int>|<range> -> fetch_nothing,
+prioid <int> <int> -> fetch_nothing,
+rangeid <int> <range> -> fetch_nothing,
shuffle [<range>] -> fetch_nothing
swap <int> <int> -> fetch_nothing
swapid <int> <int> -> fetch_nothing
save <str> -> fetch_nothing
== Database Commands
+albumart <str> <int> -> fetch_object
count <str> <str> -> fetch_object
count group <str> -> fetch_object
find <str> <str> [<str> <str>]... -> fetch_songs
list <str> [<str> <str>]...[group <str>]... -> fetch_list
listall [<str>] -> fetch_database
listallinfo [<str>] -> fetch_database
+listfiles <str> -> fetch_database
lsinfo [<str>] -> fetch_database
-readcomments <str> -> fetch_object
+readcomments [<str>] -> fetch_object
search <str> <str> [<str> <str>]... -> fetch_song
searchadd <str> <str> [<str> <str>]... -> fetch_nothing
searchaddpl <str> <str> <str> [<str> <str>]... -> fetch_nothing
rescan [<str>] -> fetch_item
== Mounts and neighbors ==
-
-mount <str> <str> -> self._fetch_nothing
-unmount <str> -> self._fetch_nothing
-listmounts -> self._fetch_mounts
-listneighbors -> self._fetch_neighbors
+mount <str> <str> -> fetch_nothing
+unmount <str> -> fetch_nothing
+listmounts -> fetch_mounts
+listneighbors -> fetch_neighbors
== Sticker Commands
sticker get <str> <str> <str> -> fetch_item
sticker find <str> <str> <str> -> fetch_songs
== Connection Commands
-close -> None
-kill -> None
-password <str> -> fetch_nothing
-ping -> fetch_nothing
+close -> None
+kill -> None
+password <str> -> fetch_nothing
+ping -> fetch_nothing
+tagtypes -> fetch_list
+tagtypes disable: <str> [<str>]... -> fetch_nothing
+tagtypes enable: <str> [<str>]... -> fetch_nothing
+tagtypes clear: -> fetch_nothing
+tagtypes all: -> fetch_nothing
== Partition Commands
partition <str> -> fetch_nothing
newpartition <str> -> fetch_nothing
== Audio Output Commands
-disableoutput <int> -> fetch_nothing
-enableoutput <int> -> fetch_nothing
-toggleoutput <int> -> fetch_nothing
-outputs -> fetch_outputs
+disableoutput <int> -> fetch_nothing
+enableoutput <int> -> fetch_nothing
+toggleoutput <int> -> fetch_nothing
+outputs -> fetch_outputs
+outputset <str> <str> <str> -> fetch_nothing
== Reflection Commands
config -> fetch_object
commands -> fetch_list
notcommands -> fetch_list
-tagtypes -> fetch_list
urlhandlers -> fetch_list
decoders -> fetch_plugins
Using the client library
=========================
-The client library can be used as follows::
+The client library can be used as follows:
+
+.. code-block:: python
client = musicpd.MPDClient() # create client object
client.connect() # use MPD_HOST/MPD_PORT if set else
# test ${XDG_RUNTIME_DIR}/mpd/socket for existence
# fallback to localhost:6600
# connect support host/port argument as well
- print client.mpd_version # print the mpd version
- print client.cmd('one', 2) # print result of the command "cmd one 2"
- client.close() # send the close command
+ print(client.mpd_version) # print the mpd protocol version
+ print(client.cmd('one', 2)) # print result of the command "cmd one 2"
client.disconnect() # disconnect from the server
-A list of supported commands, their arguments (as MPD currently understands
-them), and the functions used to parse their responses can be found in
-`doc/commands.txt`. See the `MPD protocol documentation`_ for more
-details.
+For a list of supported commands, their arguments (as MPD currently understands
+them), and the functions used to parse their responses see :ref:`commands`.
+
+See the `MPD protocol documentation`_ for more details.
Command lists are also supported using `command_list_ok_begin()` and
-`command_list_end()` ::
+`command_list_end()` :
+
+.. code-block:: python
client.command_list_ok_begin() # start a command list
client.update() # insert the update command into the list
results = client.command_list_end() # results will be a list with the results
Provide a 2-tuple as argument for command supporting ranges (cf. `MPD protocol documentation`_ for more details).
-Possible ranges are: "START:END", "START:" and ":" ::
+Possible ranges are: "START:END", "START:" and ":" :
+
+.. code-block:: python
# An intelligent clear
# clears played track in the queue, currentsong included
client.delete((pos,)) # purge queue from current to the end
A notable case is the `rangeid` command allowing an empty range specified
-as a single colon as argument (i.e. sending just ":")::
+as a single colon as argument (i.e. sending just ":"):
+
+.. code-block:: python
# sending "rangeid :" to clear the range, play everything
client.rangeid(()) # send an empty tuple
Commands may also return iterators instead of lists if `iterate` is set to
-`True`::
+`True`:
+
+.. code-block:: python
client.iterate = True
for song in client.playlistinfo():
Each command have a *send\_<CMD>* and a *fetch\_<CMD>* variant, which allows to
send a MPD command and then fetch the result later.
-This is useful for the idle command::
+This is useful for the idle command:
+
+.. code-block:: python
>>> client.send_idle()
# do something else or use function like select()
home / dev / repositories / python-musicpd.git / commitdiff