mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

netjack2: Improve docs

Browse source 
Remove unused option.
Clarify that channels and midi port are chosen by the server.

See #4666
This commit is contained in:
Wim Taymans 2025-04-28 11:12:06 +02:00
parent 84c18df626
commit 93ee66dcab
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/modules/module-netjack2-driver.c
View file

@ -63,11 +63,12 @@
* - `source.ip =<str>`: IP address to bind to, default "0.0.0.0" * - `source.ip =<str>`: IP address to bind to, default "0.0.0.0"
* - `source.port =<int>`: port to bind to, default 0 (allocate) * - `source.port =<int>`: port to bind to, default 0 (allocate)
* - `netjack2.client-name`: the name of the NETJACK2 client. * - `netjack2.client-name`: the name of the NETJACK2 client.
* - `netjack2.save`: if jack port connections should be save automatically. Can also be
* placed per stream.
* - `netjack2.latency`: the latency in cycles, default 2 * - `netjack2.latency`: the latency in cycles, default 2
* - `audio.channels`: the number of audio ports. Can also be added to the stream props. * - `audio.channels`: the number of audio ports. Can also be added to the stream props.
* Will always be configured to the channel count of the manager. The audio.position
* can however be used to assign an audio position.
* - `midi.ports`: the number of midi ports. Can also be added to the stream props. * - `midi.ports`: the number of midi ports. Can also be added to the stream props.
* Will always be configured to the number of midi ports on the manager.
* - `source.props`: Extra properties for the source filter. * - `source.props`: Extra properties for the source filter.
* - `sink.props`: Extra properties for the sink filter. * - `sink.props`: Extra properties for the sink filter.
* *
@ -95,7 +96,6 @@
* args = { * args = {
* #driver.mode = duplex * #driver.mode = duplex
* #netjack2.client-name = PipeWire * #netjack2.client-name = PipeWire
* #netjack2.save = false
* #netjack2.latency = 2 * #netjack2.latency = 2
* #midi.ports = 0 * #midi.ports = 0
* #audio.channels = 2 * #audio.channels = 2
@ -151,7 +151,6 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
"( source.ip=<ip address to bind, default 0.0.0.0> ) " \ "( source.ip=<ip address to bind, default 0.0.0.0> ) " \
"( source.port=<port to bind, default 0> ) " \ "( source.port=<port to bind, default 0> ) " \
"( netjack2.client-name=<name of the NETJACK2 client> ) " \ "( netjack2.client-name=<name of the NETJACK2 client> ) " \
"( netjack2.save=<bool, save ports> ) " \
"( netjack2.latency=<latency in cycles, default 2> ) " \ "( netjack2.latency=<latency in cycles, default 2> ) " \
"( midi.ports=<number of midi ports> ) " \ "( midi.ports=<number of midi ports> ) " \
"( audio.channels=<number of channels> ) " \ "( audio.channels=<number of channels> ) " \