Skip to content

Commit 944ccdd

Browse files
authored
111 feature request add instructions for pipe output (#112)
* Progress for #111 * Completing changes for #111
1 parent d6986dc commit 944ccdd

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ VARIABLE|DEFAULT|NOTES
7575
SPOTIFY_USERNAME||Your Spotify username. Required only if you want to disable discovery (DEPRECATED).
7676
SPOTIFY_PASSWORD||Your Spotify password. Required only if you want to disable discovery (DEPRECATED).
7777
BITRATE|160|Bitrate (kbps): `96`, `160`, `320`. Defaults to `160`.
78-
BACKEND|alsa|Audio backend to use. Use `?` to list options. Currently possible values are `alsa` and `pulseaudio`.
78+
BACKEND|alsa|Audio backend to use. Use `?` to list options. Currently possible values are `alsa`, `pulseaudio` and `pipe`.
7979
INITIAL_VOLUME||Initial volume in % from 0-100. Default for softvol: `50`. For the `alsa` mixer: the current volume.
8080
DEVICE_NAME||Device name (spaces allowed).
8181
DEVICE_TYPE|speaker|Displayed device type: `computer`, `tablet`, `smartphone`, `speaker`, `tv`, `avr` (Audio/Video Receiver), `stb` (Set-Top Box), `audiodongle`, `gameconsole`, `castaudio`, `castvideo`, `automobile`, `smartwatch`, `chromebook`, `carthing`, `homething`. Defaults to `speaker`.
@@ -121,6 +121,27 @@ ENABLE_OAUTH||Set to `headless` to enable OAUTH authentication. You will need to
121121
LOG_COMMAND_LINE||Set to `Y` or `y` to enable, `N` or `n` to disable. Defaults to `Y`.
122122
ADDITIONAL_ARGUMENTS||Use this to add additional arguments to be appended to the command line
123123

124+
### Pipe Mode
125+
126+
When using BACKEND=pipe, specify a device (using variable DEVICE) that is mounted to a fifo file. Example:
127+
128+
```text
129+
services:
130+
librespot:
131+
image: giof71/librespot:latest
132+
network_mode: host
133+
environment:
134+
- BACKEND=pipe
135+
- DEVICE=/mnt/pipe/spotipipe
136+
- BITRATE=320
137+
- INITIAL_VOLUME=100
138+
- DEVICE_NAME=SpotiPi
139+
volumes:
140+
- /path/to/folder/for/fifo-file:/mnt/pipe
141+
```
142+
143+
Thank you @marco79cgn for your contributions on [issue #111](https://github.com/GioF71/librespot-docker/issues/111).
144+
124145
### Volumes
125146

126147
Volume|Description

0 commit comments

Comments
 (0)