From 0f565910f7222bacb6c3ed13e725ffb81a9b45d9 Mon Sep 17 00:00:00 2001 From: boyska Date: Sat, 27 Mar 2021 12:56:00 +0100 Subject: [PATCH] doc: explain audiogenerators/audiospec some more --- doc/source/about.rst | 4 ++++ doc/source/install.rst | 9 ++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/source/about.rst b/doc/source/about.rst index aac6ef7..89c7d98 100644 --- a/doc/source/about.rst +++ b/doc/source/about.rst @@ -40,6 +40,10 @@ action For example, ``{ 'kind': 'randomdir', 'paths': ['/my/dir', '/other/path'] }`` will pick a random file from one of the two paths. + Its main atribute is ``kind``. The kind essentialy specifies the function that will be run among a + predefined set of :doc:`audiogenerators` . Every other attribute is an argument to the specified + audiogenerator. + event An event is an alarm plus a list of actions. At given times, do those things diff --git a/doc/source/install.rst b/doc/source/install.rst index 69cfbb5..59bcccf 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -85,9 +85,12 @@ Events CONTINOUS_AUDIOSPEC when the playlist is too short, larigira picks something new. How? this is controlled by this variable. 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}``. You could, for example, change it to - ``{ "kind": "randomdir", "paths": ["/var/music"], "howmany": 10}`` - or to ``{"kind": "mpd", "howmany": 5, "prefix": "background"}``. + 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 Yes, there's a typo in the name, but I'll keep it like this for compatibility EVENT_FILTERS