McSinyx
/
vicious
mirror of https://github.com/vicious-widgets/vicious
1
1
Fork 0
Code Issues Releases Activity

Add documentation

This commit is contained in:
Cássio Ávila 2023-12-05 22:05:10 -03:00
parent fb4daaaad6
commit 0623f04b07
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/widgets.rst
View File

@ -290,14 +290,16 @@ Provides Music Player Daemon information.
Supported platforms: platform independent (required tools: ``curl``).
* Argument: an array including password, hostname and port in that order.
* Argument: an array including password, hostname, port and separator in that order, or a table with the previously mentioned fields.
``nil`` fields will be fallen back to default
(``localhost:6600`` without password).
(``localhost:6600`` without password and ``", "`` as a separator).
* Returns a table with string keys: ``${volume}``, ``${bitrate}``,
``${elapsed}`` (in seconds), ``${duration}`` (in seconds),
``${Elapsed}`` (formatted as [hh:]mm:ss),
``${Duration}`` (formatted as [hh:]mm:ss), ``${Progress}`` (in percentage),
``${random}``, ``${repeat}``, ``${state}``, ``${Artist}``, ``${Title}``,
``${Artists}`` (All artists concatenated with the configured separator),
``${Generes}`` (All generes concatenated with the configured separator),
``${Album}``, ``${Genre}`` and optionally ``${Name}`` and ``${file}``.
In addition, some common mpd commands are available as functions: