mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/dox/config/index.md

54 lines
2.2 KiB
Markdown
Raw Normal View History

doc: add 'Configuration' page Add pointer for readers to Wiki and WirePlumber docs, where the documentation actually is at, so the configuration docs can found starting from docs.pipewire.org
2024-02-04 12:14:31 +02:00
\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:
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
- \ref page_man_pipewire_conf_5 "PipeWire daemon configuration reference"
- \ref page_man_pipewire-pulse_conf_5 "PipeWire Pulseaudio daemon configuration reference"
doc: add 'Configuration' page Add pointer for readers to Wiki and WirePlumber docs, where the documentation actually is at, so the configuration docs can found starting from docs.pipewire.org
2024-02-04 12:14:31 +02:00
- [WirePlumber daemon configuration](https://pipewire.pages.freedesktop.org/wireplumber/)
Configuration of devices:
- [WirePlumber configuration](https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration.html)
doc: rename pipewire-devices.7 and move stream properties into it Collect the list of object properties into a single place. Group properties in the index based on the object type. Consider "Monitor" as a separate object type, as it's generally configured separately. Add something about Port, Link, and Client properties. Just explain some of these as they're fairly technical, so just link to API docs.
2024-07-23 21:36:34 +03:00
- \ref page_man_pipewire-props_7 "Object property reference"
doc: move configuration index to a separate page Also add index to pipewire-props
2024-07-28 18:21:25 +03:00
- \subpage page_config_xref "Configuration Index"
doc: add 'Configuration' page Add pointer for readers to Wiki and WirePlumber docs, where the documentation actually is at, so the configuration docs can found starting from docs.pipewire.org
2024-02-04 12:14:31 +02:00
Configuration for client applications, either connecting via the
native PipeWire interface, or the emulated ALSA, JACK, or PulseAudio
interfaces:
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
- \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"
doc: add reference docs + index for config and env variables 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.
2023-12-09 18:34:56 +02:00
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
# 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
doc: rename pipewire-devices.7 and move stream properties into it Collect the list of object properties into a single place. Group properties in the index based on the object type. Consider "Monitor" as a separate object type, as it's generally configured separately. Add something about Port, Link, and Client properties. Just explain some of these as they're fairly technical, so just link to API docs.
2024-07-23 21:36:34 +03:00
- \subpage page_man_pipewire-props_7
doc: add some more coverage Fix some copypaste mistakes and other errors. Add explanations for some more properties. Explain "drop-in" config files. Explain filter-chain.conf. Move configuration man pages under Configuration in TOC.
2024-02-18 21:43:23 +02:00
- \subpage page_man_pipewire-pulse-modules_7
- \subpage page_man_libpipewire-modules_7
Reference in a new issue Copy permalink