module-combine-stream: improve docs

This commit is contained in:
Wim Taymans 2023-03-23 11:47:27 +01:00
parent d3cd900d06
commit d78bea5e32

View file

@ -35,6 +35,10 @@
* - a new virtual sink that forwards audio to other sinks * - a new virtual sink that forwards audio to other sinks
* - a new virtual source that combines audio from other sources * - a new virtual source that combines audio from other sources
* *
* The sources and sink that need to be combined can be selected using generic match
* rules. This makes it possible to combine static nodes or nodes based on certain
* properties.
*
* ## Module Options * ## Module Options
* *
* - `node.name`: a unique name for the stream * - `node.name`: a unique name for the stream
@ -42,6 +46,7 @@
* - `combine.mode` = capture | playback | sink | source, default sink * - `combine.mode` = capture | playback | sink | source, default sink
* - `combine.props = {}`: properties to be passed to the sink/source * - `combine.props = {}`: properties to be passed to the sink/source
* - `stream.props = {}`: properties to be passed to the streams * - `stream.props = {}`: properties to be passed to the streams
* - `stream.rules = {}`: rules for matching streams, use create-stream actions
* *
* ## General options * ## General options
* *