From d7dfec8cb34405e18f2d6abf80691dab8bd152ad Mon Sep 17 00:00:00 2001
From: Wim Taymans <wtaymans@redhat.com>
Date: Wed, 28 Aug 2024 10:25:19 +0200
Subject: [PATCH] modules: add an example of a downmix source in loopback

See #4236
---
 src/modules/module-loopback.c | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/src/modules/module-loopback.c b/src/modules/module-loopback.c
index 6933c0ee7..28db32c26 100644
--- a/src/modules/module-loopback.c
+++ b/src/modules/module-loopback.c
@@ -162,6 +162,33 @@
  * ]
  *\endcode
  *
+ * ## Example configuration of a downmix source
+ *
+ * This Virtual source has 2 input channels and a mono output channel. It will perform
+ * downmixing from the two first AUX channels of a pro-audio device.
+ *
+ *\code{.unparsed}
+ * context.modules = [
+ * {   name = libpipewire-module-loopback
+ *     args = {
+ *         node.description = "Downmix Source"
+ *         audio.position = [ AUX0 AUX1 ]
+ *         capture.props = {
+ *             node.name = "effect_input.downmix"
+ *             target.object = "alsa_input.usb-BEHRINGER_UMC404HD_192k-00.pro-input-0"
+ *             node.passive = true
+ *             stream.dont-remix = true
+ *         }
+ *         playback.props = {
+ *             node.name = "effect_output.downmix"
+ *             media.class = Audio/Source
+ *             audio.position = [ MONO ]
+ *         }
+ *     }
+ * }
+ * ]
+ *\endcode
+ *
  * ## See also
  *
  * `pw-loopback` : a tool that loads the loopback module with given parameters.