modules: clean up USAGE arguments

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

View file

@ -128,21 +128,21 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
#define DEFAULT_TTL 1
#define DEFAULT_LOOP false
#define USAGE "control.ip=<destination IP address, default:"DEFAULT_CONTROL_IP"> " \
"control.port=<int, default:"SPA_STRINGIFY(DEFAULT_CONTROL_PORT)"> " \
"local.ifname=<local interface name to use> " \
"net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> " \
"net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> " \
"net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> " \
"sess.name=<a name for the session> " \
"sess.min-ptime=<minimum packet time in milliseconds, default:2> " \
"sess.max-ptime=<maximum packet time in milliseconds, default:20> " \
"sess.media=<string, the media type audio|midi|opus, default audio> " \
"audio.format=<format, default:"DEFAULT_FORMAT"> " \
"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= { key=value ... }"
#define USAGE "( control.ip=<destination IP address, default:"DEFAULT_CONTROL_IP"> ) " \
"( control.port=<int, default:"SPA_STRINGIFY(DEFAULT_CONTROL_PORT)"> ) " \
"( local.ifname=<local interface name to use> ) " \
"( net.mtu=<desired MTU, default:"SPA_STRINGIFY(DEFAULT_MTU)"> ) " \
"( net.ttl=<desired TTL, default:"SPA_STRINGIFY(DEFAULT_TTL)"> ) " \
"( net.loop=<desired loopback, default:"SPA_STRINGIFY(DEFAULT_LOOP)"> ) " \
"( sess.name=<a name for the session> ) " \
"( sess.min-ptime=<minimum packet time in milliseconds, default:2> ) " \
"( sess.max-ptime=<maximum packet time in milliseconds, default:20> ) " \
"( sess.media=<string, the media type audio|midi|opus, default audio> ) " \
"( audio.format=<format, default:"DEFAULT_FORMAT"> ) " \
"( 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= { key=value ... } ) "
static const struct spa_dict_item module_info[] = {
{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },