From 1008f918c97fe776ea4eb9313ef925cd66eec820 Mon Sep 17 00:00:00 2001
From: Mike Brady <4265913+mikebrady@users.noreply.github.com>
Date: Mon, 22 Jun 2026 18:48:02 +0100
Subject: [PATCH] Add note about new --with-metadata-pipe and
 --with-metadata-multicast configuration flags.

---
 scripts/shairport-sync.conf | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/scripts/shairport-sync.conf b/scripts/shairport-sync.conf
index 86009806..52ab212e 100644
--- a/scripts/shairport-sync.conf
+++ b/scripts/shairport-sync.conf
@@ -325,13 +325,16 @@ dsp =
 // How to deal with metadata, including artwork
 // For this section to be operative, Shairport Sync must be built with at one (or more) of the following configuration flags:
 // --with-metadata, --with-dbus-interface, --with-mpris-interface or --with-mqtt-client.
-// In those cases, "enabled" and "include_cover_art" will both be "yes" by default
+// In those cases, "enabled" and "include_cover_art" will both be "yes" by default.
+// To get metadata through a unix pipe, Shairport Sync must be built with the --with-metadata-pipe configuration flag.
+// To get metadata through a multicast port, Shairport Sync must be built with the --with-metadata-multicast configuration flag.
+
 metadata =
 {
 //	enabled = "yes"; // set this to yes to get Shairport Sync to solicit metadata from the source and to pass it on via a pipe
 //	include_cover_art = "yes"; // set to "yes" to get Shairport Sync to solicit cover art from the source and pass it via the pipe. You must also set "enabled" to "yes".
 //	cover_art_cache_directory = "/tmp/shairport-sync/.cache/coverart"; // artwork will be  stored in this directory if the dbus or MPRIS interfaces are enabled or if the MQTT client is in use. Set it to "" to prevent caching, which may be useful on some systems
-//	pipe_name = "/tmp/shairport-sync-metadata";
+//	pipe_name = "/tmp/shairport-sync-metadata"; 
 //	pipe_timeout = 5000; // wait for this number of milliseconds for a blocked pipe to unblock before giving up
 //	progress_interval = 0.0; // if non-zero, progress 'phbt' messages will be sent at the interval specified in seconds. A 'phb0' message will also be sent when the first audio frame of a play session is about to be played.
 //		Each message consists of the RTPtime of a a frame of audio and the exact system time when it is to be played. The system time, in nanoseconds, is based the CLOCK_MONOTONIC_RAW of the machine -- if available -- or CLOCK_MONOTONIC otherwise.