X-Git-Url: http://git.kaliko.me/?p=python-musicpd.git;a=blobdiff_plain;f=doc%2Fsource%2Fuse.rst;h=d8e46e7e7c216143d980d72bd4f3b3628c428683;hp=fdc13178306852e2d1cf48e97470018cff65a75c;hb=e4003597f43ccb041f81827b56c082cf5554098d;hpb=a1d6fc6df18bca9a06232a77deecf241f48de92c diff --git a/doc/source/use.rst b/doc/source/use.rst index fdc1317..d8e46e7 100644 --- a/doc/source/use.rst +++ b/doc/source/use.rst @@ -1,25 +1,28 @@ 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 @@ -27,7 +30,9 @@ Command lists are also supported using `command_list_ok_begin()` and 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 @@ -38,7 +43,9 @@ Possible ranges are: "START:END", "START:" and ":" :: 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 @@ -47,7 +54,9 @@ Empty start in range (i.e. ":END") are not possible and will raise a CommandErro 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(): @@ -55,7 +64,9 @@ Commands may also return iterators instead of lists if `iterate` is set to Each command have a *send\_* and a *fetch\_* 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()