pipewire/doc/dox/config/index.md
Pauli Virtanen 030768ab8e 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
2024-02-26 19:11:15 +02:00

3.5 KiB

\page page_config Configuration

One of the design goals of PipeWire is to be able to closely control and configure all aspects of the processing graph.

A fully configured PipeWire setup runs various pieces, each with their configuration options and files:

  • pipewire: The PipeWire main daemon that runs and coordinates the processing.

  • pipewire-pulse: The PipeWire PulseAudio replacement server. It also configures the properties of the PulseAudio clients connecting to it.

  • wireplumber: Most configuration of devices is performed by the session manager. It typically loads ALSA and other devices and configures the profiles, port volumes and more. The session manager also configures new clients and links them to the targets, as configured in the session manager policy.

  • PipeWire clients: Each native PipeWire client also loads a configuration file. Emulated JACK client also have separate configuration.

Configuration Settings

Configuration of daemons:

Configuration of devices:

Configuration for client applications, either connecting via the native PipeWire interface, or the emulated ALSA, JACK, or PulseAudio interfaces:

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