mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

modules: improve docs

Browse source
This commit is contained in:
Wim Taymans 2022-06-23 12:48:45 +02:00
parent c8b8b24a9c
commit 60cbc44526
6 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/modules/module-echo-cancel.c
View file

@ -80,6 +80,7 @@
*
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION
* - \ref PW_KEY_MEDIA_CLASS
* - \ref PW_KEY_NODE_LATENCY
* - \ref PW_KEY_NODE_NAME
@ -89,7 +90,6 @@
* - \ref PW_KEY_NODE_VIRTUAL
* - \ref PW_KEY_NODE_LATENCY
* - \ref PW_KEY_REMOTE_NAME
* - \ref SPA_KEY_AUDIO_POSITION
*
* ## Example configuration
*\code{.unparsed}

1
src/modules/module-example-sink.c
View file

@ -64,6 +64,7 @@
* Options with well-known behavior.
*
* - \ref PW_KEY_REMOTE_NAME
* - \ref PW_KEY_AUDIO_FORMAT
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION

1
src/modules/module-example-source.c
View file

@ -64,6 +64,7 @@
* Options with well-known behavior.
*
* - \ref PW_KEY_REMOTE_NAME
* - \ref PW_KEY_AUDIO_FORMAT
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION

1
src/modules/module-pipe-tunnel.c
View file

@ -84,6 +84,7 @@
* Options with well-known behavior.
*
* - \ref PW_KEY_REMOTE_NAME
* - \ref PW_KEY_AUDIO_FORMAT
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION

2
src/modules/module-pulse-tunnel.c
View file

@ -80,6 +80,7 @@
* Options with well-known behavior.
*
* - \ref PW_KEY_REMOTE_NAME
* - \ref PW_KEY_AUDIO_FORMAT
* - \ref PW_KEY_AUDIO_RATE
* - \ref PW_KEY_AUDIO_CHANNELS
* - \ref SPA_KEY_AUDIO_POSITION
@ -128,6 +129,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ node.target=<remote node target name> ] " \
"[ audio.format=<sample format> ] " \
"[ audio.rate=<sample rate> ] " \
"[ audio.channels=<number of channels> ] " \
"[ audio.position=<channel map> ] " \

2
src/modules/module-raop-sink.c
View file

@ -110,7 +110,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
"[ node.name=<name of the nodes> ] " \
"[ node.description=<description of the nodes> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAuLT_RATE)"> ] " \
"[ audio.rate=<sample rate, default: "SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.channels=<number of channels, default:"SPA_STRINGIFY(DEFAULT_CHANNELS)"> ] " \
"[ audio.position=<channel map, default:"DEFAULT_POSITION"> ] " \
"[ stream.props=<properties> ] "