mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-04 13:30:12 -05:00
improve module docs
This commit is contained in:
parent
b3bb7fd567
commit
c324a9fb42
2 changed files with 5 additions and 8 deletions
|
|
@ -36,7 +36,7 @@
|
||||||
* The jack-tunnel module provides a source or sink that tunnels all audio to
|
* The jack-tunnel module provides a source or sink that tunnels all audio to
|
||||||
* a JACK server.
|
* a JACK server.
|
||||||
*
|
*
|
||||||
* This module is usually used together with module-jack-dbus that will
|
* This module is usually used together with \ref page_module_jackdbus_detect that will
|
||||||
* automatically load the tunnel with the right parameters based on dbus
|
* automatically load the tunnel with the right parameters based on dbus
|
||||||
* information.
|
* information.
|
||||||
*
|
*
|
||||||
|
|
@ -102,6 +102,7 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
|
||||||
#define DEFAULT_POSITION "[ FL FR ]"
|
#define DEFAULT_POSITION "[ FL FR ]"
|
||||||
|
|
||||||
#define MODULE_USAGE "( remote.name=<remote> ] " \
|
#define MODULE_USAGE "( remote.name=<remote> ] " \
|
||||||
|
"( jack.library=<jack library path> ) " \
|
||||||
"( jack.server=<server name> ) " \
|
"( jack.server=<server name> ) " \
|
||||||
"( jack.client-name=<name of the JACK client> ] " \
|
"( jack.client-name=<name of the JACK client> ] " \
|
||||||
"( jack.connect=<bool, autoconnect ports> ] " \
|
"( jack.connect=<bool, autoconnect ports> ] " \
|
||||||
|
|
|
||||||
|
|
@ -33,11 +33,7 @@
|
||||||
* ## Module Options
|
* ## Module Options
|
||||||
*
|
*
|
||||||
* There are no module-specific options, all arguments are passed to
|
* There are no module-specific options, all arguments are passed to
|
||||||
* \page page_module_jack_tunnel.
|
* \ref page_module_jack_tunnel.
|
||||||
*
|
|
||||||
* ## General options
|
|
||||||
*
|
|
||||||
* There are no general options for this module.
|
|
||||||
*
|
*
|
||||||
* ## Example configuration
|
* ## Example configuration
|
||||||
*\code{.unparsed}
|
*\code{.unparsed}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue