mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: clarify JSON usage

Browse source 
Mention that the config format can be pure JSON or with some
simplifications and additions.
This commit is contained in:
Wim Taymans 2021-08-04 11:45:54 +02:00
parent 02b4ccd782
commit 4841156b74
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/pipewire-daemon.dox
View file

@ -71,9 +71,11 @@ directory, subdirectory and filename, respectively.
\subsection sec_config_format Configuration File Format \subsection sec_config_format Configuration File Format
PipeWire's configuration file format resembles JSON. Unlike true JSON, no PipeWire's configuration file format is JSON. In addition to true JSON,
trailing commas are required and comments starting with `#` are permitted as PipeWire also understands a more compact JSON representation where
shown below. `"` can be omitted around strings, no trailing commas are required and
`:` or `=` can be used to separate object keys from their values.
Also, `#` can be used to start a comment until the end of the line.
The configuration file format is grouped into sections. A section is The configuration file format is grouped into sections. A section is
either a dictionary (`{}`) or an array (`[]`). Dictionary and array entries either a dictionary (`{}`) or an array (`[]`). Dictionary and array entries