diff --git a/doc/configuration.md b/doc/configuration.md index 4e58ff84..516d36f1 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -25,9 +25,11 @@ Available types are: ### pipe ```sh -pipe:///?name=[&mode=create][&dryout_ms=2000], mode can be "create" or "read" +pipe:///?name=[&mode=create][&dryout_ms=2000] ``` +`mode` can be `create` or `read`. Sometimes your audio source might insist in creating the pipe itself. So the pipe creation mode can by changed to "not create, but only read mode", using the `mode` option set to `read` + ### librespot ```sh @@ -37,18 +39,24 @@ librespot:///?name=[&dryout_ms=2000][&username=?name= ``` +TODO: description of the parameters + ### process ```sh process:///?name=[&dryout_ms=2000][&wd_timeout=0][&log_stderr=false][¶ms=] ``` +TODO: description of the parameters + ### airplay ```sh @@ -58,6 +66,8 @@ airplay:///?name=[&dryout_ms=2000][&port=5000] note that you need to have the airplay binary on your machine sampleformat will be set to `44100:16:2` +TODO: description of the parameters + ### tcp server ```sh