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

modules: clean up USAGE arguments

Browse source 
use () to mark optional arguments to avoid confusion with arrays.
Add some more optional arguments.
This commit is contained in:
Wim Taymans 2023-03-22 16:35:55 +01:00
parent 3decaa6457
commit 07e6f44e58
24 changed files with 200 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

26
src/modules/module-protocol-simple.c
View file

@ -49,7 +49,7 @@
* - `capture.node`: an optional node serial or name to use for capture.
* - `playback.node`: an optional node serial or name to use for playback.
* - `server.address = []`: an array of server addresses to listen on as
* tcp:<ip>:<port>.
* tcp:(<ip>:)<port>.
*
* ## General options
*
@ -119,18 +119,18 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define MAX_CLIENTS 10
#define MODULE_USAGE "[ capture=<bool> ] " \
"[ playback=<bool> ] " \
"[ remote.name=<remote> ] " \
"[ node.latency=<num/denom, default:"DEFAULT_LATENCY"> ] " \
"[ node.rate=<1/rate, default:1/"SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ capture.node=<source-target> [ stream.capture.sink=true ]] " \
"[ playback.node=<sink-target> ] " \
"[ audio.rate=<sample-rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ] " \
"[ audio.format=<format, default:"DEFAULT_FORMAT"> ] " \
"[ audio.channels=<channels, default: "SPA_STRINGIFY(DEFAULT_CHANNELS)"> ] " \
"[ audio.position=<position, default:"DEFAULT_POSITION"> ] " \
"[ server.address=<[ tcp:[<ip>:]<port>[,...] ], default:"DEFAULT_SERVER">" \
#define MODULE_USAGE "( capture=<bool> ) " \
"( playback=<bool> ) " \
"( remote.name=<remote> ) " \
"( node.latency=<num/denom, default:"DEFAULT_LATENCY"> ) " \
"( node.rate=<1/rate, default:1/"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( capture.node=<source-target> ( stream.capture.sink=true )) " \
"( playback.node=<sink-target> ) " \
"( audio.rate=<sample-rate, default:"SPA_STRINGIFY(DEFAULT_RATE)"> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( audio.channels=<channels, default: "SPA_STRINGIFY(DEFAULT_CHANNELS)"> ) " \
"( audio.position=<position, default:"DEFAULT_POSITION"> ) " \
"( server.address=<[ tcp:(<ip>:)<port>(,...) ], default:"DEFAULT_SERVER"> )" \
static const struct spa_dict_item module_props[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },