mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-03 09:01:54 -05:00
fd58eec7f8
Add reference documentation for configuration settings & node/device properties. We should have boring & exhaustive reference lists of all the options, and an index where they can be looked up as needed. The content is mostly stolen from the Wiki. Add pipewire-client.conf.5, pipewire-jack.conf.5, and pipewire-device.7 that try to explain all available configuration settings for native/ALSA/JACK clients, and parameters & properties devices. Expand pipewire.conf.5 and pipewire-pulse.conf.5 with lists of supported properties. Also explain environment variables. Doxygen doesn't have an indexing mechanism suitable for configuration settings, so add a simple one using an input filter and use it here. Tweak styling a bit.
21 lines
545 B
Text
21 lines
545 B
Text
/** \page page_tutorial API Tutorial
|
|
|
|
Welcome to the PipeWire API tutorial. The goal is to learn
|
|
PipeWire API step-by-step with simple short examples.
|
|
|
|
- \subpage page_tutorial1
|
|
- \subpage page_tutorial2
|
|
- \subpage page_tutorial3
|
|
- \subpage page_tutorial4
|
|
- \subpage page_tutorial5
|
|
- \subpage page_tutorial6
|
|
|
|
|
|
# More Example Programs
|
|
|
|
- \ref audio-src.c "": \snippet{doc} audio-src.c title
|
|
- \ref audio-dsp-filter.c "": \snippet{doc} audio-dsp-filter.c title
|
|
- \ref video-play.c "": \snippet{doc} video-play.c title
|
|
- \subpage page_examples
|
|
|
|
*/
|