Skip to content

Commit

Permalink
111 feature request add instructions for pipe output (#112)
Browse files Browse the repository at this point in the history
* Progress for #111

* Completing changes for #111
  • Loading branch information
GioF71 authored Jan 25, 2025
1 parent d6986dc commit 944ccdd
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ VARIABLE|DEFAULT|NOTES
SPOTIFY_USERNAME||Your Spotify username. Required only if you want to disable discovery (DEPRECATED).
SPOTIFY_PASSWORD||Your Spotify password. Required only if you want to disable discovery (DEPRECATED).
BITRATE|160|Bitrate (kbps): `96`, `160`, `320`. Defaults to `160`.
BACKEND|alsa|Audio backend to use. Use `?` to list options. Currently possible values are `alsa` and `pulseaudio`.
BACKEND|alsa|Audio backend to use. Use `?` to list options. Currently possible values are `alsa`, `pulseaudio` and `pipe`.
INITIAL_VOLUME||Initial volume in % from 0-100. Default for softvol: `50`. For the `alsa` mixer: the current volume.
DEVICE_NAME||Device name (spaces allowed).
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`.
Expand Down Expand Up @@ -121,6 +121,27 @@ ENABLE_OAUTH||Set to `headless` to enable OAUTH authentication. You will need to
LOG_COMMAND_LINE||Set to `Y` or `y` to enable, `N` or `n` to disable. Defaults to `Y`.
ADDITIONAL_ARGUMENTS||Use this to add additional arguments to be appended to the command line

### Pipe Mode

When using BACKEND=pipe, specify a device (using variable DEVICE) that is mounted to a fifo file. Example:

```text
services:
librespot:
image: giof71/librespot:latest
network_mode: host
environment:
- BACKEND=pipe
- DEVICE=/mnt/pipe/spotipipe
- BITRATE=320
- INITIAL_VOLUME=100
- DEVICE_NAME=SpotiPi
volumes:
- /path/to/folder/for/fifo-file:/mnt/pipe
```

Thank you @marco79cgn for your contributions on [issue #111](https://github.com/GioF71/librespot-docker/issues/111).

### Volumes

Volume|Description
Expand Down

0 comments on commit 944ccdd

Please sign in to comment.