diff --git a/src/modules/module-snapcast-discover.c b/src/modules/module-snapcast-discover.c index 788128265..47a72d1f7 100644 --- a/src/modules/module-snapcast-discover.c +++ b/src/modules/module-snapcast-discover.c @@ -65,6 +65,26 @@ * - `stream.rules` = : match rules, use create-stream actions. See * \ref page_module_protocol_simple for module properties. * + * ### stream.rules matches + * + * - `snapcast.ip`: the IP address of the snapcast server + * - `snapcast.port`: the port of the snapcast server + * - `snapcast.ifindex`: the interface index where the snapcast announcement + * was received. + * - `snapcast.ifname`: the interface name where the snapcast announcement + * was received. + * - `snapcast.name`: the name of the snapcast server + * - `snapcast.hostname`: the hostname of the snapcast server + * - `snapcast.domain`: the domain of the snapcast server + * + * ### stream.rules create-stream + * + * In addition to all the properties that can be passed to + * \ref page_module_protocol_simple, you can also set: + * + * - `snapcast.stream-name`: The name of the stream on a snapcast server. + * - `node.name`: The name of the sink that is created on the sender. + * * ## Example configuration * *\code{.unparsed} @@ -74,9 +94,9 @@ * stream.rules = [ * { matches = [ * { snapcast.ip = "~.*" + * #snapcast.port = 1000 * #snapcast.ifindex = 1 * #snapcast.ifname = eth0 - * #snapcast.port = 1000 * #snapcast.name = "" * #snapcast.hostname = "" * #snapcast.domain = "" @@ -89,13 +109,17 @@ * #audio.channels = 2 * #audio.position = [ FL FR ] * # + * # The stream name as is appears on the snapcast + * # server: * #snapcast.stream-name = "PipeWire" * # + * # The name of the sink on the sender: + * #node.name = "Snapcast Sink" + * # * #capture = true * #server.address = [ "tcp:4711" ] * #capture.props = { * #target.object = "" - * #node.name = "Snapcast Sink" * #node.latency = 2048/48000 * #media.class = "Audio/Sink" * #}