modules: add an example of a downmix source in loopback

See #4236
This commit is contained in:
Wim Taymans 2024-08-28 10:25:19 +02:00
parent 48c2e95165
commit d7dfec8cb3

View file

@ -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.