+.. SPDX-FileCopyrightText: 2018-2021 kaliko <kaliko@azylum.org>
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
Using the client library
=========================
See the `MPD protocol documentation`_ for more details.
+.. _environment_variables:
+
Environment variables
---------------------
* ``MPD_TIMEOUT`` timeout for connecting to MPD and waiting for MPD’s response in seconds
* ``XDG_RUNTIME_DIR`` path to look for potential socket: ``${XDG_RUNTIME_DIR}/mpd/socket``
-Defaults settings
------------------
+.. _default_settings:
+
+Default settings
+----------------
* If ``MPD_HOST`` is not set, then look for a socket in ``${XDG_RUNTIME_DIR}/mpd/socket``
* If there is no socket use ``localhost``
* If ``MPD_PORT`` is not set, then use ``6600``
* If ``MPD_TIMEOUT`` is not set, then uses :py:obj:`musicpd.CONNECTION_TIMEOUT`
+
+Context manager
+---------------
+
+Calling MPDClient in a context manager :py:obj:`musicpd.MPDClient.connect` is
+transparently called with :ref:`default setting<default_settings>` (use
+:ref:`environment variables<environment_variables>` to override defaults).
+Leaving the context manager :py:obj:`musicpd.MPDClient.disconnect` is called.
+
+.. code-block:: python
+
+ import os
+ os.environ['MPD_HOST'] = 'mpdhost'
+ with MPDClient() as c:
+ c.status()
+ c.next()
+
Command lists
-------------
----------------------
Each command have a *send\_<CMD>* and a *fetch\_<CMD>* variant, which allows to
-send a MPD command and then fetch the result later.
+send a MPD command and then fetch the result later (non-blocking call).
This is useful for the idle command:
.. code-block:: python
>>> gobject.io_add_watch(client, gobject.IO_IN, callback)
>>> gobject.MainLoop().run()
+See also use of :ref:`socket timeout<socket_timeout>` with idle command.
+
Fetching binary content (cover art)
-----------------------------------
Refer to `MPD protocol documentation`_ for the meaning of `binary`, `size` and `data`.
+.. _socket_timeout:
+
Socket timeout
--------------
cli.noidle()
except socket.timeout as err:
print(f'{err} (timeout {cli.socket_timeout})')
+ except (OSError, musicpd.MPDError) as err:
+ print(f'{err!r}')
+ if cli._sock is not None:
+ cli.disconnect()
except KeyboardInterrupt:
pass
All three commands in the while loop (send_idle, fetch_idle, noidle) are not
triggering a socket timeout unless the connection is actually lost (actually it
-could also be that MPD took to much time to answer, but MPD taking more than a
+could also be that MPD took too much time to answer, but MPD taking more than a
couple of seconds for these commands should never occur).
.. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
+.. vim: spell spelllang=en