doc: syntax

This commit is contained in:
boyska 2021-03-27 12:57:56 +01:00
parent 0f565910f7
commit 19a1e3de1b

View file

@ -87,10 +87,12 @@ CONTINOUS_AUDIOSPEC
This variable should be set to the JSON representation of an audiospec describing how to generate new
audios. The default is ``{"kind": "mpd", "howmany": 1}``, which picks a random song from MPD library. You could, for example, change it to:
- ``{ "kind": "randomdir", "paths": ["/var/music"], "howmany": 5}`` to pick files from a specified
directory, ignoring MPD library completely. Here, ``howmany`` is set to 5 for performance sake
- ``{"kind": "mpd", "howmany": 10, "prefix": "background"}`` if you want to use the MPD library, but only
use one of its subdirectories. Please note that using ``mpd`` with a ``prefix`` can be slow, so this is setting ``howmany`` to 10 to gain some performance
- ``{ "kind": "randomdir", "paths": ["/var/music"], "howmany": 5}``
to pick files from a specified directory, ignoring MPD library completely. Here, ``howmany`` is set to 5 for performance sake
- ``{"kind": "mpd", "howmany": 10, "prefix": "background"}``
if you want to use the MPD library, but only use one of its subdirectories.
Since using ``mpd`` with a ``prefix`` can be slow, so this is setting ``howmany`` to 10 to
gain some performance
Yes, there's a typo in the name, but I'll keep it like this for compatibility
EVENT_FILTERS