mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

conf: fixup config comments

Browse source 
Use () to mark optional fields to avoid confusion with [] for arrays.
Add contition fields where available.
This commit is contained in:
Wim Taymans 2023-02-07 10:35:43 +01:00
parent 5552ff7fdd
commit fda829a1fa
7 changed files with 28 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/daemon/client-rt.conf.in
View file

@ -31,8 +31,9 @@ context.spa-libs = {
context.modules = [ context.modules = [
#{ name = <module-name> #{ name = <module-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ ifexists ] [ nofail ] ] # ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Loads a module with the given parameters. # Loads a module with the given parameters.

5
src/daemon/client.conf.in
View file

@ -31,8 +31,9 @@ context.spa-libs = {
context.modules = [ context.modules = [
#{ name = <module-name> #{ name = <module-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ ifexists ] [ nofail ] ] # ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Loads a module with the given parameters. # Loads a module with the given parameters.

5
src/daemon/filter-chain.conf.in
View file

@ -30,8 +30,9 @@ context.spa-libs = {
context.modules = [ context.modules = [
#{ name = <module-name> #{ name = <module-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ ifexists ] [ nofail ] ] # ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Loads a module with the given parameters. # Loads a module with the given parameters.

5
src/daemon/jack.conf.in
View file

@ -30,8 +30,9 @@ context.spa-libs = {
context.modules = [ context.modules = [
#{ name = <module-name> #{ name = <module-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ ifexists ] [ nofail ] ] # ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Loads a module with the given parameters. # Loads a module with the given parameters.

15
src/daemon/minimal.conf.in
View file

@ -60,8 +60,9 @@ context.spa-libs = {
context.modules = [ context.modules = [
#{ name = <module-name> #{ name = <module-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ ifexists ] [ nofail ] ] # ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Loads a module with the given parameters. # Loads a module with the given parameters.
@ -135,8 +136,9 @@ context.modules = [
context.objects = [ context.objects = [
#{ factory = <factory-name> #{ factory = <factory-name>
# [ args = { <key> = <value> ... } ] # ( args = { <key> = <value> ... } )
# [ flags = [ [ nofail ] ] # ( flags = [ ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#} #}
# #
# Creates an object from a PipeWire factory with the given parameters. # Creates an object from a PipeWire factory with the given parameters.
@ -339,7 +341,10 @@ context.objects = [
] ]
context.exec = [ context.exec = [
#{ path = <program-name> [ args = "<arguments>" ] } #{ path = <program-name>
# ( args = "<arguments>" )
# ( condition = [ { <key> = <value> ... } ... ] )
#}
# #
# Execute the given program with arguments. # Execute the given program with arguments.
# #

4
src/daemon/pipewire-pulse.conf.in
View file

@ -57,11 +57,11 @@ context.exec = [
# Extra commands can be executed here. # Extra commands can be executed here.
# load-module : loads a module with args and flags # load-module : loads a module with args and flags
# args = "<module-name> <module-args>" # args = "<module-name> <module-args>"
# flags = [ "no-fail" ] # ( flags = [ nofail ] )
pulse.cmd = [ pulse.cmd = [
{ cmd = "load-module" args = "module-always-sink" flags = [ ] } { cmd = "load-module" args = "module-always-sink" flags = [ ] }
#{ cmd = "load-module" args = "module-switch-on-connect" } #{ cmd = "load-module" args = "module-switch-on-connect" }
#{ cmd = "load-module" args = "module-gsettings" flags = [ "nofail" ] } #{ cmd = "load-module" args = "module-gsettings" flags = [ nofail ] }
] ]
stream.properties = { stream.properties = {

5
src/modules/module-protocol-pulse/cmd.c
View file

@ -76,7 +76,10 @@ static int do_cmd(struct impl *impl, const char *cmd, char *args, const char *fl
/* /*
* pulse.cmd = [ * pulse.cmd = [
* { cmd = <command> [ args = "<arguments>" ] } * { cmd = <command>
* ( args = "<arguments>" )
* ( flags = [ ( nofail ) ] )
* }
* ... * ...
* ] * ]
*/ */