mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-24 07:00:05 -05:00
doc: sync with master branch
Pick relevant doc updates. doc: fix DoxygenLayout.xml for doxygen 1.10 doc: add reference docs + index for config and env variables doc: add some more coverage doc: move config man pages under config/ doc: add sections to index, clarify discussion of properties doc: disable dot graphs in API docs again doc: some updates doc: fix up example dependencies in meson
This commit is contained in:
parent
876c3f43ab
commit
030768ab8e
20 changed files with 2600 additions and 185 deletions
|
|
@ -23,20 +23,67 @@ configuration options and files:
|
|||
|
||||
Configuration of daemons:
|
||||
|
||||
- [PipeWire daemon configuration](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PipeWire)
|
||||
- \ref page_man_pipewire_conf_5 "PipeWire daemon configuration reference"
|
||||
- \ref page_man_pipewire-pulse_conf_5 "PipeWire Pulseaudio daemon configuration reference"
|
||||
- [WirePlumber daemon configuration](https://pipewire.pages.freedesktop.org/wireplumber/)
|
||||
- [PipeWire PulseAudio daemon configuration](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio)
|
||||
- [Wiki page on PipeWire daemon configuration](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PipeWire)
|
||||
- [Wiki page on PipeWire PulseAudio daemon configuration](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio)
|
||||
|
||||
Configuration of devices:
|
||||
|
||||
- [WirePlumber configuration](https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration.html)
|
||||
- [Device runtime settings](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-Devices)
|
||||
- \ref page_man_pipewire-devices_7 "Device and node property reference"
|
||||
- [Wiki page on device runtime settings](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-Devices)
|
||||
|
||||
Configuration for client applications, either connecting via the
|
||||
native PipeWire interface, or the emulated ALSA, JACK, or PulseAudio
|
||||
interfaces:
|
||||
|
||||
- [PipeWire native clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-client)
|
||||
- [PipeWire ALSA clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-ALSA)
|
||||
- [PipeWire JACK clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-JACK)
|
||||
- [PipeWire PulseAudio clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio)
|
||||
- \ref page_man_pipewire-client_conf_5 "PipeWire native and ALSA client configuration reference"
|
||||
- \ref page_man_pipewire-jack_conf_5 "PipeWire JACK client configuration reference"
|
||||
- \ref page_man_pipewire-pulse_conf_5 "PipeWire Pulseaudio client configuration reference"
|
||||
- [Wiki page on native clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-client)
|
||||
- [Wiki page on ALSA clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-ALSA)
|
||||
- [Wiki page on JACK clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-JACK)
|
||||
- [Wiki page on PulseAudio clients](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio)
|
||||
|
||||
# Manual Pages
|
||||
|
||||
- \subpage page_man_pipewire_conf_5
|
||||
- \subpage page_man_pipewire-client_conf_5
|
||||
- \subpage page_man_pipewire-pulse_conf_5
|
||||
- \subpage page_man_pipewire-jack_conf_5
|
||||
- \subpage page_man_pipewire-filter-chain_conf_5
|
||||
- \subpage page_man_pipewire-devices_7
|
||||
- \subpage page_man_pipewire-pulse-modules_7
|
||||
- \subpage page_man_libpipewire-modules_7
|
||||
|
||||
# Configuration Index
|
||||
|
||||
\ref page_man_pipewire_conf_5 "pipewire.conf"
|
||||
|
||||
@SECREF@ pipewire.conf
|
||||
|
||||
\ref page_man_pipewire-pulse_conf_5 "pipewire-pulse.conf"
|
||||
|
||||
@SECREF@ pipewire-pulse.conf
|
||||
|
||||
\ref page_man_pipewire-client_conf_5 "client.conf, client-rt.conf"
|
||||
|
||||
@SECREF@ client.conf
|
||||
|
||||
\ref page_man_pipewire-jack_conf_5 "jack.conf"
|
||||
|
||||
@SECREF@ jack.conf
|
||||
|
||||
**Runtime settings**
|
||||
|
||||
@SECREF@ pipewire-settings
|
||||
|
||||
**Environment variables**
|
||||
|
||||
@SECREF@ pipewire-env client-env jack-env pulse-env
|
||||
|
||||
**Device properties**
|
||||
|
||||
@SECREF@ device-param
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue