3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-04-30 18:57:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update configuration.md

Browse source
This commit is contained in:
Johannes Pohl 2020-08-31 09:54:38 +02:00 • committed by GitHub
parent 57f09c09e3
commit 26c7d6cf58
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/configuration.md
View file

@ -25,9 +25,11 @@ Available types are:
### pipe ### pipe
```sh ```sh
pipe:///<path/to/pipe>?name=<name>[&mode=create][&dryout_ms=2000], mode can be "create" or "read" pipe:///<path/to/pipe>?name=<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 ### librespot
```sh ```sh
@ -37,18 +39,24 @@ librespot:///<path/to/librespot>?name=<name>[&dryout_ms=2000][&username=<my user
note that you need to have the librespot binary on your machine note that you need to have the librespot binary on your machine
sampleformat will be set to `44100:16:2` sampleformat will be set to `44100:16:2`
TODO: description of the parameters
### file ### file
```sh ```sh
file:///<path/to/PCM/file>?name=<name> file:///<path/to/PCM/file>?name=<name>
``` ```
TODO: description of the parameters
### process ### process
```sh ```sh
process:///<path/to/process>?name=<name>[&dryout_ms=2000][&wd_timeout=0][&log_stderr=false][&params=<process arguments>] process:///<path/to/process>?name=<name>[&dryout_ms=2000][&wd_timeout=0][&log_stderr=false][&params=<process arguments>]
``` ```
TODO: description of the parameters
### airplay ### airplay
```sh ```sh
@ -58,6 +66,8 @@ airplay:///<path/to/airplay>?name=<name>[&dryout_ms=2000][&port=5000]
note that you need to have the airplay binary on your machine note that you need to have the airplay binary on your machine
sampleformat will be set to `44100:16:2` sampleformat will be set to `44100:16:2`
TODO: description of the parameters
### tcp server ### tcp server
```sh ```sh