nils/shairport-sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revise configuration flags and add metadata options [skip ci]

Browse Source 
Updated the configuration flags documentation to indicate deprecation of the --with-jack flag and added new sections for metadata pipe and multicast.
This commit is contained in:
Mike Brady
2026-06-22 12:57:18 +01:00
committed by GitHub
parent 77efa15d16
commit 6a0f5385bc
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONFIGURATION FLAGS.md
+15 -3
View File
@@ -37,7 +37,7 @@ Here are the audio backend configuration options:
- `--with-sndio` Output to the FreeBSD-native [sndio](https://sndio.org) system.
- `--with-pipewire` Output to the [PipeWire](https://pipewire.org) sound server.
- `--with-pulseaudio` Include the [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio) sound server.
- `--with-jack` Output to the [Jack Audio](https://jackaudio.org) system.
- `--with-jack` Output to the [Jack Audio](https://jackaudio.org) system. This is now deprecated.
- `--with-ao` Output to the [libao](https://xiph.org/ao/) system. No synchronisation.
- `--with-stdout` Include an optional backend module to enable raw audio to be output through standard output (`STDOUT`).
- `--with-pipe` Include an optional backend module to enable raw audio to be output through a unix pipe.
@@ -65,9 +65,21 @@ PipeWire and PulseAudio provide a default ALSA pseudo device, so that Shairport
| ----- |
| `--with-metadata` |
Metadata such as track name, artist name, album name, cover art and more can be requested from the player and passed to other applications.
Metadata such as track name, artist name, album name, cover art and more can be requested from the player and passed to other applications through a Unix pipe, multicast, a D-Bus interface or an MPRIS interface.
- `--with-metadata` Adds support for Shairport Sync to request metadata and to pipe it to a compatible application. See https://github.com/mikebrady/shairport-sync-metadata-reader for a sample metadata reader.
## Metadata Pipe
| Flags |
| ----- |
| `--with-metadata-pipe` |
- `--with-metadata-pipe` Adds support for Shairport Sync to send metadata into a Unix `pipe` that can be read by another application. See https://github.com/mikebrady/shairport-sync-metadata-reader for a sample metadata reader.
## Metadata Multicast
| Flags |
| ----- |
| `--with-metadata-multicast` |
- `--with-metadata-multicast` Adds support for Shairport Sync to multicast metadata. Specify the multicast socket address and port in the `metadata` section of the configuration file.
## Inter Process Communication