doc: in user-facing config examples, indicate which file it goes into

Add suggestions for config fragments in config file examples, as
applicable.
This commit is contained in:
Pauli Virtanen 2024-09-14 15:43:25 +03:00 committed by Wim Taymans
parent 97719948a5
commit ec5684302c
34 changed files with 144 additions and 26 deletions

View file

@ -82,6 +82,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-combine-stream-1.conf
*
* context.modules = [
* { name = libpipewire-module-combine-stream
* args = {
@ -122,6 +124,8 @@
* from 3 separate stereo sinks.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-combine-stream-2.conf
*
* context.modules = [
* { name = libpipewire-module-combine-stream
* args = {
@ -170,6 +174,8 @@
* from 2 separate stereo sources.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-combine-stream-3.conf
*
* context.modules = [
* { name = libpipewire-module-combine-stream
* args = {

View file

@ -117,6 +117,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-echo-cancel.conf
*
* context.modules = [
* { name = libpipewire-module-echo-cancel
* args = {

View file

@ -65,6 +65,8 @@
* ## Example configuration of a virtual source
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-example-filter.conf
*
* context.modules = [
* { name = libpipewire-module-example-filter
* args = {

View file

@ -63,6 +63,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-example-sink.conf
*
* context.modules = [
* { name = libpipewire-module-example-sink
* args = {

View file

@ -63,6 +63,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-example-source.conf
*
* context.modules = [
* { name = libpipewire-module-example-source
* args = {

View file

@ -76,6 +76,8 @@
* ## Example configuration of a duplex sink/source
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-ffado-driver.conf
*
* context.modules = [
* { name = libpipewire-module-ffado-driver
* args = {

View file

@ -477,7 +477,12 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
* This example uses the rnnoise LADSPA plugin to create a new
* virtual source.
*
* Run with `pipewire -c filter-chain.conf`. The configuration can also
* be put under `pipewire.conf.d/` to run it inside the PipeWire server.
*
*\code{.unparsed}
* # ~/.config/pipewire/filter-chain.conf.d/my-filter-chain-1.conf
*
* context.modules = [
* { name = libpipewire-module-filter-chain
* args = {
@ -515,6 +520,8 @@ PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
* to a stereo Dolby Surround signal.
*
*\code{.unparsed}
* # ~/.config/pipewire/filter-chain.conf.d/my-filter-chain-2.conf
*
* context.modules = [
* { name = libpipewire-module-filter-chain
* args = {

View file

@ -75,6 +75,8 @@
* ## Example configuration of a duplex sink/source
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-jack-tunnel.conf
*
* context.modules = [
* { name = libpipewire-module-jack-tunnel
* args = {

View file

@ -42,6 +42,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-jack-dbus-detect.conf
*
* context.modules = [
* { name = libpipewire-module-jackdbus-detect
* args {

View file

@ -82,6 +82,8 @@
* This Virtual sink routes stereo input to the rear channels of a 7.1 sink.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-loopback-1.conf
*
* context.modules = [
* { name = libpipewire-module-loopback
* args = {
@ -111,6 +113,8 @@
* This is useful for splitting up multi-channel inputs from USB audio interfaces that are not yet fully supported by alsa.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-loopback-2.conf
*
* context.modules = [
* { name = libpipewire-module-loopback
* args = {
@ -137,6 +141,8 @@
* using the PSD algorithm on the playback stream.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-loopback-3.conf
*
* context.modules = [
* { name = libpipewire-module-loopback
* args = {
@ -168,6 +174,8 @@
* downmixing from the two first AUX channels of a pro-audio device.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-loopback-4.conf
*
* context.modules = [
* { name = libpipewire-module-loopback
* args = {

View file

@ -87,6 +87,8 @@
* ## Example configuration of a duplex sink/source
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-netjack2-driver.conf
*
* context.modules = [
* { name = libpipewire-module-netjack2-driver
* args = {

View file

@ -92,6 +92,8 @@
* ## Example configuration of a duplex sink/source
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-netjack2-manager.conf
*
* context.modules = [
* { name = libpipewire-module-netjack2-manager
* args = {

View file

@ -69,6 +69,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-parametric-equalizer.conf
*
* context.modules = [
* { name = libpipewire-module-parametric-equalizer
* args = {

View file

@ -93,6 +93,8 @@
* ## Example configuration of a pipe playback stream
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-pipe-tunnel.conf
*
* context.modules = [
* { name = libpipewire-module-pipe-tunnel
* args = {

View file

@ -48,6 +48,8 @@
* A config section with server properties can be given.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire-pulse.conf.d/custom.conf
*
* pulse.properties = {
* # the addresses this server listens on
* server.address = [
@ -297,6 +299,8 @@
* section with a `quirks` and an `update-props` action.
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire-pulse.conf.d/custom.conf
*
* pulse.rules = [
* {
* # skype does not want to use devices that don't have an S16 sample format.
@ -343,6 +347,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire-pulse.conf.d/custom.conf
*
* context.modules = [
* { name = libpipewire-module-protocol-pulse
* args = { }

View file

@ -83,6 +83,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-protocol-simple.conf
*
* context.modules = [
* { name = libpipewire-module-protocol-simple
* args = {

View file

@ -83,6 +83,8 @@
* ## Example configuration of a virtual sink
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-pulse-tunnel.conf
*
* context.modules = [
* { name = libpipewire-module-pulse-tunnel
* args = {

View file

@ -55,6 +55,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-raop-discover.conf
*
* context.modules = [
* { name = libpipewire-module-raop-discover
* args = {

View file

@ -94,6 +94,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-raop-sink.conf
*
* context.modules = [
* { name = libpipewire-module-raop-sink
* args = {

View file

@ -56,6 +56,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-roc-sink.conf
*
* context.modules = [
* { name = libpipewire-module-roc-sink
* args = {

View file

@ -59,6 +59,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-roc-source.conf
*
* context.modules = [
* { name = libpipewire-module-roc-source
* args = {

View file

@ -73,6 +73,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-rtp-sap.conf
*
* context.modules = [
* { name = libpipewire-module-rtp-sap
* args = {

View file

@ -97,6 +97,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-rtp-session.conf
*
* context.modules = [
* { name = libpipewire-module-rtp-session
* args = {

View file

@ -87,6 +87,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-rtp-sink.conf
*
* context.modules = [
* { name = libpipewire-module-rtp-sink
* args = {

View file

@ -81,6 +81,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-rtp-source.conf
*
* context.modules = [
* { name = libpipewire-module-rtp-source
* args = {

View file

@ -88,6 +88,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-snapcast-discover.conf
*
* context.modules = [
* { name = libpipewire-module-snapcast-discover
* args = {

View file

@ -77,6 +77,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-vban-recv.conf
*
* context.modules = [
* { name = libpipewire-module-vban-recv
* args = {

View file

@ -78,6 +78,8 @@
*
* ## Example configuration
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-vban-send.conf
*
* context.modules = [
* { name = libpipewire-module-vban-send
* args = {

View file

@ -48,6 +48,8 @@
* ## Example configuration
*
*\code{.unparsed}
* # ~/.config/pipewire/pipewire.conf.d/my-zeroconf-discover.conf
*
* context.modules = [
* { name = libpipewire-module-zeroconf-discover
* args = { }