Debian Codegraph @

docs/rst/daemon/configuration/features.rst

raw
1 .. _config_features:
2
3 Well-known features
4 ===================
5
6 This is a list of some well-known features that can be enabled or
7 disabled accordingly.
8
9 There are many more features actually defined in the configuration file, and it
10 can be confusing to go through them. This list here is meant to be a quick
11 reference for the most common ones that actually make sense to be toggled in
12 a configuration file in order to customize WirePlumber's behavior.
13
14 For more information on what features are and how they work, refer to the
15 previous section: :ref:`config_components_and_profiles`.
16
17 Hardware monitors
18 -----------------
19
20 Audio
21 ~~~~~
22
23 .. describe:: hardware.audio
24
25 Enables bringing up audio hardware.
26
27 :wants: ``monitor.alsa``, ``monitor.alsa-midi``
28
29 .. describe:: monitor.alsa
30
31 Enables the ALSA device monitor.
32
33 :wants: ``monitor.alsa.reserve-device``
34
35 .. describe:: monitor.alsa.reserve-device
36
37 Enables D-Bus device reservation API for ALSA devices.
38
39 :requires: ``support.reserve-device``
40
41 .. describe:: monitor.alsa-midi
42
43 Enables the ALSA MIDI device monitor.
44
45 .. describe:: node.software-dsp
46
47 Enables software DSP based on pre-configured hardware rules.
48
49 See :ref:`policies_software_dsp` for more information.
50
51 Bluetooth
52 ~~~~~~~~~
53
54 .. describe:: hardware.bluetooth
55
56 Enables bringing up bluetooth hardware.
57
58 :wants: ``monitor.bluez``, ``monitor.bluez-midi``
59
60 .. describe:: monitor.bluez
61
62 Enables the BlueZ device monitor.
63
64 :wants: ``monitor.bluez.seat-monitoring``
65
66 .. describe:: monitor.bluez.seat-monitoring
67
68 Enables seat monitoring on the bluetooth monitor.
69
70 When enabled, this will make sure that the bluetooth devices are only
71 enabled on the active seat.
72
73 :requires: ``support.logind``
74
75 .. describe:: monitor.bluez-midi
76
77 Enables the BlueZ MIDI device monitor.
78
79 :wants: ``monitor.bluez.seat-monitoring``
80
81 Video
82 ~~~~~
83
84 .. describe:: hardware.video-capture
85
86 Enables bringing up video capture hardware (cameras, hdmi capture devices,
87 etc.)
88
89 :wants: ``monitor.v4l2``, ``monitor.libcamera``
90
91 .. describe:: monitor.v4l2
92
93 Enables the V4L2 device monitor.
94
95 .. describe:: monitor.libcamera
96
97 Enables the libcamera device monitor.
98
99 Support components
100 ------------------
101
102 .. describe:: support.dbus
103
104 Provides a D-Bus connection to the session bus. This is needed by some other
105 support features (see below) but it is generally optional. WirePlumber does
106 not require a D-Bus connection to work.
107
108 On a system where WirePlumber is configured to run system-wide (headless,
109 embedded, etc), this will most likely fail to load and thus disable all the
110 other support features that require it. On such systems it makes sense to
111 disable this feature explicitly, to avoid the overhead of trying to connect
112 to the session bus.
113
114 .. describe:: support.reserve-device
115
116 Provides support for the
117 `D-Bus device reservation API <http://git.0pointer.net/reserve.git/tree/reserve.txt>`_,
118 allowing the device monitors to reserve devices for exclusive access.
119
120 :requires: ``support.dbus``
121
122 .. describe:: support.portal-permissionstore
123
124 Integrates with the flatpak portal permission store to give appropriate
125 access permissions to flatpak applications.
126
127 :requires: ``support.dbus``
128
129 .. describe:: support.logind
130
131 Integrates with systemd-logind to enable specific functionality only on the
132 active seat.
133
134 Policies
135 --------
136
137 .. describe:: policy.standard
138
139 Enables the standard WirePlumber policy. This includes all the logic
140 for enabling devices, linking streams, granting permissions to clients,
141 etc, as appropriate for a desktop system.
142
143 .. describe:: policy.role-based
144
145 Enables the role based priority system policy. This system creates virtual sinks
146 that group streams based on their ``media.role`` property, and assigns a
147 priority to each role. Depending on the priority configuration, lower
148 priority roles may be corked or ducked when a higher priority role stream
149 is active.
150
151 This policy was designed for automotive and mobile systems and may not work
152 as expected on desktop systems.
153
154 Note that this policy is implemented as a superset of ``policy.standard``,
155 so ``policy.standard`` should not be disabled when enabling this policy.
156
157 :requires: ``policy.standard``