docs: improve bluetooth documentation and example config file
This commit is contained in:
George Kiagiadakis
@@ -3,255 +3,438 @@
|
||||
Bluetooth configuration
|
||||
=======================
|
||||
|
||||
Using the same format as the :ref:`ALSA monitor <config_alsa>`, the
|
||||
configuration file ``wireplumber.conf.d/bluetooth.conf`` configures
|
||||
the Bluetooth devices and nodes created by WirePlumber.
|
||||
Bluetooth audio and MIDI devices are managed by the BlueZ and BlueZ-MIDI
|
||||
monitors, respectively.
|
||||
|
||||
* *Settings*
|
||||
Both monitors are enabled by default and can be disabled using the
|
||||
``monitor.bluez`` and ``monitor.bluez-midi`` :ref:`features <config_features>`
|
||||
in the configuration file.
|
||||
|
||||
Example:
|
||||
As with all device monitors, both of these monitors are implemented as SPA
|
||||
plugins and are part of PipeWire. WirePlumber merely loads the plugins and lets
|
||||
them do their work. These plugins then monitor the BlueZ system-wide D-Bus
|
||||
service and create device and node objects for all the connected Bluetooth audio
|
||||
and MIDI devices.
|
||||
|
||||
.. code-block::
|
||||
Logind integration
|
||||
------------------
|
||||
|
||||
monitor.bluez.properties = {
|
||||
bluez5.roles = "[ a2dp_sink a2dp_source bap_sink bap_source hsp_hs hsp_ag hfp_hf hfp_ag ]"
|
||||
}
|
||||
The BlueZ monitors are integrated with logind to ensure that only one user at a
|
||||
time can use the Bluetooth audio devices. This is because on most Linux desktop
|
||||
systems, the graphical login manager (GDM, SDDM, etc.) is running as a separate
|
||||
user and runs its own instance of PipeWire and Wireplumber. This means that if a
|
||||
user logs in graphically, the Bluetooth audio devices will be automatically
|
||||
grabbed by the PipeWire/WirePlumber instance of the graphical login manager,
|
||||
and the user that logs in will not get access to them.
|
||||
|
||||
Enabled headset roles (default: [ a2dp_sink a2dp_source bap_sink bap_source hsp_hs hsp_ag hfp_hf hfp_ag ]).
|
||||
Some headsets (e.g. Sony WH-1000XM3) do not work with both hsp_ag and hfp_ag enabled,
|
||||
so `hsp_ag` and `hfp_ag` are disabled by default.
|
||||
To overcome this, the BlueZ monitors are integrated with logind and are only
|
||||
allowed to create device and node objects for Bluetooth audio devices if the
|
||||
user is currently on the "active" logind session.
|
||||
|
||||
Supported roles:
|
||||
In some cases, however, this behavior is not desired. For example, if you
|
||||
manually switch to a TTY and log in there, you may want to keep the Bluetooth
|
||||
audio devices connected to the now inactive graphical session. Or you may want
|
||||
to have a dedicated user that is always allowed to use the Bluetooth audio
|
||||
devices, regardless of the active logind session, for example for a (possibly
|
||||
headless) music player daemon.
|
||||
|
||||
- ``hsp_hs`` (HSP Headset)
|
||||
- ``hsp_ag`` (HSP Audio Gateway),
|
||||
- ``hfp_hf`` (HFP Hands-Free),
|
||||
- ``hfp_ag`` (HFP Audio Gateway)
|
||||
- ``a2dp_sink`` (A2DP Audio Sink)
|
||||
- ``a2dp_source`` (A2DP Audio Source)
|
||||
- ``bap_sink`` (LE Audio Basic Audio Profile Sink)
|
||||
- ``bap_source`` (LE Audio Basic Audio Profile Source)
|
||||
To disable this behavior, you can set the ``monitor.bluez.seat-monitoring``
|
||||
:ref:`feature <config_features>` to ``disabled``.
|
||||
|
||||
.. code-block::
|
||||
Example configuration :ref:`fragment <config_conf_file_fragments>` file:
|
||||
|
||||
bluez5.codecs = "[ sbc sbc_xq aac ]"
|
||||
.. code-block::
|
||||
|
||||
Enables the specified A2DP codecs. All codecs are enabled by default.
|
||||
wireplumber.profiles = {
|
||||
main = {
|
||||
monitor.bluez.seat-monitoring = disabled
|
||||
}
|
||||
}
|
||||
|
||||
Supported codecs:``sbc``, ``sbc_xq``, ``aac``, ``ldac``, ``aptx``,
|
||||
``aptx_hd``, ``aptx_ll``, ``aptx_ll_duplex``, ``faststream``,
|
||||
``faststream_duplex``, ``lc3plus_h3``, ``opus_05``, ``opus_05_51``, ``opus_05_71``,
|
||||
``opus_05_duplex``, ``opus_05_pro``, ``lc3``.
|
||||
.. note::
|
||||
|
||||
.. code-block::
|
||||
If logind is not installed on the system, this functionality is disabled
|
||||
automatically.
|
||||
|
||||
bluez5.hfphsp-backend = "native"
|
||||
Monitor Properties
|
||||
------------------
|
||||
|
||||
HFP/HSP backend (default: native). Available values: ``any``, ``none``,
|
||||
``hsphfpd``, ``ofono`` or ``native``.
|
||||
The BlueZ monitor SPA plugin (``api.bluez5.enum.dbus``) supports properties that
|
||||
can be used to configure it when it is loaded. These properties can be set in
|
||||
the ``monitor.bluez.properties`` section of the WirePlumber configuration file.
|
||||
|
||||
.. code-block::
|
||||
Example:
|
||||
|
||||
bluez5.hfphsp-backend-native-modem = "none"
|
||||
.. code-block::
|
||||
|
||||
Modem to use for native HFP/HSP backend ModemManager support. When enabled,
|
||||
PipeWire will forward HFP commands to the specified ModemManager device.
|
||||
This corresponds to the 'Device' property of the org.freedesktop.ModemManager1.Modem
|
||||
interface. May also be ``any`` to use any available modem device.
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.hw-offload-sco = false
|
||||
|
||||
HFP/HSP hardware offload SCO support (default: false). Using this
|
||||
feature requires a custom WirePlumber script that handles audio
|
||||
routing in a platform-specific way. See
|
||||
``tests/examples/bt-pinephone.lua`` for an example.
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.default.rate = 48000
|
||||
|
||||
The bluetooth default audio rate.
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.default.channels = 2
|
||||
|
||||
The Bluetooth default number of channels.
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.dummy-avrcp-player = false
|
||||
|
||||
Register dummy AVRCP player. Some devices have wrongly functioning
|
||||
volume or playback controls if this is not enabled. Disabled by default.
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.enable-msbc = true,
|
||||
monitor.bluez.properties = {
|
||||
bluez5.roles = [ a2dp_sink a2dp_source bap_sink bap_source hsp_hs hsp_ag hfp_hf hfp_ag ]
|
||||
bluez5.codecs = [ sbc sbc_xq aac ]
|
||||
bluez5.enable-sbc-xq = true
|
||||
bluez5.enable-hw-volume = true
|
||||
bluez5.hfphsp-backend = "native"
|
||||
}
|
||||
|
||||
By default MSBC and SBC-XQ codecs and hardware volume is enabled,
|
||||
except if disabled by a hardware quirk database. You can force
|
||||
them to be enabled regardless also for devices where the database disables
|
||||
it with these options.
|
||||
.. describe:: bluez5.roles
|
||||
|
||||
.. code-block::
|
||||
Enabled roles.
|
||||
|
||||
bluez5.a2dp.opus.pro.channels = 3
|
||||
bluez5.a2dp.opus.pro.coupled-streams = 1
|
||||
bluez5.a2dp.opus.pro.locations = "FL,FR,LFE"
|
||||
bluez5.a2dp.opus.pro.max-bitrate = 600000
|
||||
bluez5.a2dp.opus.pro.frame-dms = 50
|
||||
bluez5.a2dp.opus.pro.bidi.channels = 1
|
||||
bluez5.a2dp.opus.pro.bidi.coupled-streams = 0
|
||||
bluez5.a2dp.opus.pro.bidi.locations = "FC"
|
||||
bluez5.a2dp.opus.pro.bidi.max-bitrate = 160000
|
||||
bluez5.a2dp.opus.pro.bidi.frame-dms = 400
|
||||
Currently some headsets (e.g. Sony WH-1000XM3) do not work with both
|
||||
``hsp_ag`` and ``hfp_ag`` enabled, so by default we enable only HFP.
|
||||
|
||||
Options for a custom multichannel Opus codec, which can be used to
|
||||
transport audio between devices running PipeWire.
|
||||
Supported roles:
|
||||
|
||||
* *MIDI Settings*
|
||||
- ``hsp_hs`` (HSP Headset)
|
||||
- ``hsp_ag`` (HSP Audio Gateway),
|
||||
- ``hfp_hf`` (HFP Hands-Free),
|
||||
- ``hfp_ag`` (HFP Audio Gateway)
|
||||
- ``a2dp_sink`` (A2DP Audio Sink)
|
||||
- ``a2dp_source`` (A2DP Audio Source)
|
||||
- ``bap_sink`` (LE Audio Basic Audio Profile Sink)
|
||||
- ``bap_source`` (LE Audio Basic Audio Profile Source)
|
||||
|
||||
Example:
|
||||
:Default value: ``[ a2dp_sink a2dp_source bap_sink bap_source hfp_hf hfp_ag ]``
|
||||
:Type: array of strings
|
||||
|
||||
.. code-block::
|
||||
.. describe:: bluez5.codecs
|
||||
|
||||
monitor.bluez-midi.servers = [ "bluez_midi.server" ]
|
||||
Enabled A2DP codecs.
|
||||
|
||||
List of MIDI server node names. Each node name given will create a new instance
|
||||
of a BLE MIDI service. Typical BLE MIDI instruments have on service instance,
|
||||
so adding more than one here may confuse some clients. The node property matching
|
||||
rules below apply also to these servers.
|
||||
Supported codecs: ``sbc``, ``sbc_xq``, ``aac``, ``ldac``, ``aptx``,
|
||||
``aptx_hd``, ``aptx_ll``, ``aptx_ll_duplex``, ``faststream``,
|
||||
``faststream_duplex``, ``lc3plus_h3``, ``opus_05``, ``opus_05_51``,
|
||||
``opus_05_71``, ``opus_05_duplex``, ``opus_05_pro``, ``lc3``.
|
||||
|
||||
* *Rules*
|
||||
:Default value: all available codecs
|
||||
:Type: array of strings
|
||||
|
||||
Example:
|
||||
.. describe:: bluez5.enable-msbc
|
||||
|
||||
.. code-block::
|
||||
Enable mSBC codec (wideband speech codec for HFP/HSP).
|
||||
|
||||
monitor.bluez.rules = [
|
||||
{
|
||||
matches = [
|
||||
{
|
||||
# This matches the needed sound card.
|
||||
device.name = "<bluez_sound_card_name>"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
update-props = {
|
||||
# Apply all the desired device settings here.
|
||||
bluez5.auto-connect = "[ hfp_hf hsp_hs a2dp_sink ]"
|
||||
}
|
||||
}
|
||||
}
|
||||
{
|
||||
matches = [
|
||||
# This matches the needed node.
|
||||
{
|
||||
node.name = "<node_name>"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
# Apply all the desired node specific settings here.
|
||||
update-props = {
|
||||
node.nick = "My Node"
|
||||
priority.driver = 100
|
||||
session.suspend-timeout-seconds = 5
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
This does not work on all headsets, so it is enabled based on the hardware
|
||||
quirks database. By explicitly setting this option you can force it to be
|
||||
enabled or disabled regardless.
|
||||
|
||||
This will set the auto-connect property to ``hfp_hf``, ``hsp_hs`` and
|
||||
``a2dp_sink`` on bluetooth devices whose name matches the ``bluez_card.*``
|
||||
pattern.
|
||||
:Default value: ``true``
|
||||
:Type: boolean
|
||||
|
||||
A list of valid properties are:
|
||||
.. describe:: bluez5.enable-sbc-xq
|
||||
|
||||
.. code-block::
|
||||
Enable SBC-XQ codec (high quality SBC codec for A2DP).
|
||||
|
||||
bluez5.auto-connect = "[ hfp_hf hsp_hs a2dp_sink ]"
|
||||
This does not work on all headsets, so it is enabled based on the hardware
|
||||
quirks database. By explicitly setting this option you can force it to be
|
||||
enabled or disabled regardless.
|
||||
|
||||
Auto-connect device profiles on start up or when only partial profiles have
|
||||
connected. Disabled by default if the property is not specified.
|
||||
:Default value: ``true``
|
||||
:Type: boolean
|
||||
|
||||
Supported values are: ``hfp_hf``, ``hsp_hs``, ``a2dp_sink``, ``hfp_ag``,
|
||||
``hsp_ag`` and ``a2dp_source``.
|
||||
.. describe:: bluez5.enable-hw-volume
|
||||
|
||||
.. code-block::
|
||||
Enable hardware volume controls.
|
||||
|
||||
bluez5.hw-volume = "[ hfp_ag hsp_ag a2dp_source ]"
|
||||
This does not work on all headsets, so it is enabled based on the hardware
|
||||
quirks database. By explicitly setting this option you can force it to be
|
||||
enabled or disabled regardless.
|
||||
|
||||
Hardware volume controls (default: ``hfp_ag``, ``hsp_ag``, and ``a2dp_source``)
|
||||
:Default value: ``true``
|
||||
:Type: boolean
|
||||
|
||||
Supported values are: ``hfp_hf``, ``hsp_hs``, ``a2dp_sink``, ``hfp_ag``,
|
||||
``hsp_ag`` and ``a2dp_source``.
|
||||
.. describe:: bluez5.hfphsp-backend
|
||||
|
||||
.. code-block::
|
||||
HFP/HSP backend.
|
||||
|
||||
bluez5.a2dp.ldac.quality = "auto"
|
||||
Available values: ``any``, ``none``, ``hsphfpd``, ``ofono`` or ``native``.
|
||||
|
||||
LDAC encoding quality.
|
||||
:Default value: ``native``
|
||||
:Type: string
|
||||
|
||||
Available values: ``auto`` (Adaptive Bitrate, default),
|
||||
``hq`` (High Quality, 990/909kbps), ``sq`` (Standard Quality, 660/606kbps) and
|
||||
``mq`` (Mobile use Quality, 330/303kbps).
|
||||
.. describe:: bluez5.hfphsp-backend-native-modem
|
||||
|
||||
.. code-block::
|
||||
Modem to use for native HFP/HSP backend ModemManager support. When enabled,
|
||||
PipeWire will forward HFP commands to the specified ModemManager device.
|
||||
This corresponds to the 'Device' property of the
|
||||
``org.freedesktop.ModemManager1.Modem`` interface. May also be ``any`` to
|
||||
use any available modem device.
|
||||
|
||||
bluez5.a2dp.aac.bitratemode = 0
|
||||
:Default value: ``none``
|
||||
:Type: string
|
||||
|
||||
AAC variable bitrate mode.
|
||||
.. describe:: bluez5.hw-offload-sco
|
||||
|
||||
Available values: 0 (cbr, default), 1-5 (quality level).
|
||||
HFP/HSP hardware offload SCO support.
|
||||
|
||||
.. code-block::
|
||||
Using this feature requires a custom WirePlumber script that handles audio
|
||||
routing in a platform-specific way. See ``tests/examples/bt-pinephone.lua``
|
||||
for an example.
|
||||
|
||||
device.profile = "a2dp-sink"
|
||||
:Default value: ``false``
|
||||
:Type: boolean
|
||||
|
||||
Profile connected first.
|
||||
.. describe:: bluez5.default.rate
|
||||
|
||||
Available values: ``a2dp-sink`` (default) or ``headset-head-unit``.
|
||||
The default audio rate for the A2DP codec configuration.
|
||||
|
||||
* *MIDI Rules*
|
||||
:Default value: ``48000``
|
||||
:Type: integer
|
||||
|
||||
Example:
|
||||
.. describe:: bluez5.default.channels
|
||||
|
||||
.. code-block::
|
||||
The default number of channels for the A2DP codec configuration.
|
||||
|
||||
monitor.bluez-midi.rules = [
|
||||
{
|
||||
matches = [
|
||||
{
|
||||
node.name = "~bluez_midi*"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
update-props = {
|
||||
node.nick = "My Node"
|
||||
priority.driver = 100
|
||||
priority.session = 100
|
||||
node.pause-on-idle = false
|
||||
session.suspend-timeout-seconds = 5
|
||||
monitor.channel-volumes = false
|
||||
node.latency-offset-msec = 0
|
||||
}
|
||||
:Default value: ``2``
|
||||
:Type: integer
|
||||
|
||||
.. describe:: bluez5.dummy-avrcp-player
|
||||
|
||||
Register dummy AVRCP player. Some devices have wrongly functioning volume or
|
||||
playback controls if this is not enabled. Disabled by default.
|
||||
|
||||
:Default value: ``false``
|
||||
:Type: boolean
|
||||
|
||||
.. describe:: Opus Pro Audio mode settings
|
||||
|
||||
.. code-block::
|
||||
|
||||
bluez5.a2dp.opus.pro.channels = 3
|
||||
bluez5.a2dp.opus.pro.coupled-streams = 1
|
||||
bluez5.a2dp.opus.pro.locations = [ FL,FR,LFE ]
|
||||
bluez5.a2dp.opus.pro.max-bitrate = 600000
|
||||
bluez5.a2dp.opus.pro.frame-dms = 50
|
||||
bluez5.a2dp.opus.pro.bidi.channels = 1
|
||||
bluez5.a2dp.opus.pro.bidi.coupled-streams = 0
|
||||
bluez5.a2dp.opus.pro.bidi.locations = [ FC ]
|
||||
bluez5.a2dp.opus.pro.bidi.max-bitrate = 160000
|
||||
bluez5.a2dp.opus.pro.bidi.frame-dms = 400
|
||||
|
||||
Options for the PipeWire-specific multichannel Opus codec, which can be used
|
||||
to transport audio over Bluetooth between devices running PipeWire.
|
||||
|
||||
MIDI Monitor Properties
|
||||
-----------------------
|
||||
|
||||
The BlueZ MIDI monitor SPA plugin (``api.bluez5.midi.enum``) may, in the future,
|
||||
support properties that can be used to configure it when it is loaded. These
|
||||
properties can be set in the ``monitor.bluez-midi.properties`` section of the
|
||||
WirePlumber configuration file. At the moment of writing, there are no
|
||||
properties that can be set there.
|
||||
|
||||
In addition, the BlueZ MIDI monitor supports a list of MIDI server node names
|
||||
that can be used to create Bluetooth LE MIDI service instances. These
|
||||
server node names can be set in the ``monitor.bluez-midi.servers`` section of
|
||||
the WirePlumber configuration file.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
monitor.bluez-midi.servers = [ "bluez_midi.server" ]
|
||||
|
||||
.. note::
|
||||
|
||||
Typical BLE MIDI instruments have one service instance, so adding more than
|
||||
one here may confuse some clients.
|
||||
|
||||
Rules
|
||||
-----
|
||||
|
||||
When device and node objects are created by the BlueZ monitor, they can be
|
||||
configured using rules. These rules allow matching the existing properties of
|
||||
these objects and updating them with new values. This is the main way of
|
||||
configuring Bluetooth device settings.
|
||||
|
||||
These rules can be set in the ``monitor.bluez.rules`` section of the WirePlumber
|
||||
configuration file.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
monitor.bluez.rules = [
|
||||
{
|
||||
matches = [
|
||||
{
|
||||
## This matches all bluetooth devices.
|
||||
device.name = "~bluez_card.*"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
update-props = {
|
||||
bluez5.auto-connect = [ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]
|
||||
bluez5.hw-volume = [ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]
|
||||
bluez5.a2dp.ldac.quality = "auto"
|
||||
bluez5.a2dp.aac.bitratemode = 0
|
||||
bluez5.a2dp.opus.pro.application = "audio"
|
||||
bluez5.a2dp.opus.pro.bidi.application = "audio"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
{
|
||||
matches = [
|
||||
{
|
||||
## Matches all sources.
|
||||
node.name = "~bluez_input.*"
|
||||
}
|
||||
{
|
||||
## Matches all sinks.
|
||||
node.name = "~bluez_output.*"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
update-props = {
|
||||
bluez5.media-source-role = "input"
|
||||
|
||||
Allows changing well-known node settings.
|
||||
# Common node & audio adapter properties may also be set here
|
||||
node.nick = "My Node"
|
||||
priority.driver = 100
|
||||
priority.session = 100
|
||||
node.pause-on-idle = false
|
||||
resample.quality = 4
|
||||
channelmix.normalize = false
|
||||
channelmix.mix-lfe = false
|
||||
session.suspend-timeout-seconds = 5
|
||||
monitor.channel-volumes = false
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
In addition, allows changing some MIDI-specific settings:
|
||||
Device properties
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block::
|
||||
The following properties can be set on device objects:
|
||||
|
||||
node.latency-offset-msec = 0
|
||||
.. describe:: bluez5.auto-connect
|
||||
|
||||
Latency adjustment to apply on the node. Larger values add a
|
||||
constant latency, but reduces timing jitter caused by Bluetooth
|
||||
transport.
|
||||
Auto-connect device profiles on start up or when only partial profiles have
|
||||
connected. Disabled by default if the property is not specified.
|
||||
|
||||
Supported values are: ``hfp_hf``, ``hsp_hs``, ``a2dp_sink``, ``hfp_ag``,
|
||||
``hsp_ag`` and ``a2dp_source``.
|
||||
|
||||
:Default value: ``[]``
|
||||
:Type: array of strings
|
||||
|
||||
.. describe:: bluez5.hw-volume
|
||||
|
||||
Enable hardware volume controls on these profiles.
|
||||
|
||||
Supported values are: ``hfp_hf``, ``hsp_hs``, ``a2dp_sink``, ``hfp_ag``,
|
||||
``hsp_ag`` and ``a2dp_source``.
|
||||
|
||||
:Default value: ``[ hfp_ag hsp_ag a2dp_source ]``
|
||||
:Type: array of strings
|
||||
|
||||
.. describe:: bluez5.a2dp.ldac.quality
|
||||
|
||||
LDAC encoding quality.
|
||||
|
||||
Available values: ``auto`` (Adaptive Bitrate, default), ``hq`` (High
|
||||
Quality, 990/909kbps), ``sq`` (Standard Quality, 660/606kbps) and ``mq``
|
||||
(Mobile use Quality, 330/303kbps).
|
||||
|
||||
:Default value: ``auto``
|
||||
:Type: string
|
||||
|
||||
.. describe:: bluez5.a2dp.aac.bitratemode
|
||||
|
||||
AAC variable bitrate mode.
|
||||
|
||||
Available values: 0 (cbr, default), 1-5 (quality level).
|
||||
|
||||
:Default value: ``0``
|
||||
:Type: integer
|
||||
|
||||
.. describe:: bluez5.a2dp.opus.pro.application
|
||||
|
||||
Opus Pro Audio encoding mode.
|
||||
|
||||
Available values: ``audio``, ``voip``, ``lowdelay``.
|
||||
|
||||
:Default value: ``audio``
|
||||
:Type: string
|
||||
|
||||
.. describe:: bluez5.a2dp.opus.pro.bidi.application
|
||||
|
||||
Opus Pro Audio encoding mode for bidirectional audio.
|
||||
|
||||
Available values: ``audio``, ``voip``, ``lowdelay``.
|
||||
|
||||
:Default value: ``audio``
|
||||
:Type: string
|
||||
|
||||
.. describe:: device.profile
|
||||
|
||||
The profile that is activated initially when the device is connected.
|
||||
|
||||
Available values: ``a2dp-sink`` (default) or ``headset-head-unit``.
|
||||
|
||||
:Default value: ``a2dp-sink``
|
||||
:Type: string
|
||||
|
||||
Node properties
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
The following properties can be set on node objects:
|
||||
|
||||
.. describe:: bluez5.media-source-role
|
||||
|
||||
Media source role, ``input`` or ``playback``. This controls how a media
|
||||
source device, such as a smartphone, is used by the system. Defaults to
|
||||
``playback``, playing the incoming stream out to speakers. Set to ``input``
|
||||
to use the smartphone as an input for apps (like a microphone).
|
||||
|
||||
:Default value: ``playback``
|
||||
:Type: string
|
||||
|
||||
MIDI Rules
|
||||
----------
|
||||
|
||||
Similarly to the above rules, the BlueZ MIDI monitor also supports rules that
|
||||
can be used to configure MIDI nodes when they are created.
|
||||
|
||||
These rules can be set in the ``monitor.bluez-midi.rules`` section of the
|
||||
WirePlumber configuration file.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
monitor.bluez-midi.rules = [
|
||||
{
|
||||
matches = [
|
||||
{
|
||||
node.name = "~bluez_midi.*"
|
||||
}
|
||||
]
|
||||
actions = {
|
||||
update-props = {
|
||||
node.nick = "My Node"
|
||||
priority.driver = 100
|
||||
priority.session = 100
|
||||
node.pause-on-idle = false
|
||||
session.suspend-timeout-seconds = 5
|
||||
node.latency-offset-msec = 0
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
.. note::
|
||||
|
||||
It is possible to also match MIDI server nodes by testing the ``node.name``
|
||||
property against the server node names that were set in the
|
||||
``monitor.bluez-midi.servers`` section of the WirePlumber configuration file.
|
||||
|
||||
MIDI-specific properties
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. describe:: node.latency-offset-msec
|
||||
|
||||
Latency adjustment to apply on the node. Larger values add a
|
||||
constant latency, but reduces timing jitter caused by Bluetooth
|
||||
transport.
|
||||
|
||||
:Default value: ``0``
|
||||
:Type: integer (milliseconds)
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
## The WirePlumber BLUEZ configuration
|
||||
## Template WirePlumber Bluetooth configuration
|
||||
|
||||
wireplumber.settings = {
|
||||
## Whether to store state on the filesystem.
|
||||
@@ -24,10 +24,10 @@ monitor.bluez.properties = {
|
||||
## a2dp_source (A2DP Audio Source)
|
||||
## bap_sink (LE Audio Basic Audio Profile Sink)
|
||||
## bap_source (LE Audio Basic Audio Profile Source)
|
||||
# bluez5.roles = "[ a2dp_sink a2dp_source bap_sink bap_source hsp_hs hsp_ag hfp_hf hfp_ag ]"
|
||||
# bluez5.roles = [ a2dp_sink a2dp_source bap_sink bap_source hsp_hs hsp_ag hfp_hf hfp_ag ]
|
||||
|
||||
## Enabled A2DP codecs (default: all).
|
||||
# bluez5.codecs = "[ sbc sbc_xq aac ldac aptx aptx_hd aptx_ll aptx_ll_duplex faststream faststream_duplex ]"
|
||||
# bluez5.codecs = [ sbc sbc_xq aac ldac aptx aptx_hd aptx_ll aptx_ll_duplex faststream faststream_duplex ]
|
||||
|
||||
## These features do not work on all headsets, so they are enabled
|
||||
## by default based on the hardware database. They can also be
|
||||
@@ -62,12 +62,12 @@ monitor.bluez.properties = {
|
||||
## Opus Pro Audio mode settings
|
||||
# bluez5.a2dp.opus.pro.channels = 3
|
||||
# bluez5.a2dp.opus.pro.coupled-streams = 1
|
||||
# bluez5.a2dp.opus.pro.locations = "FL,FR,LFE"
|
||||
# bluez5.a2dp.opus.pro.locations = [ FL,FR,LFE ]
|
||||
# bluez5.a2dp.opus.pro.max-bitrate = 600000
|
||||
# bluez5.a2dp.opus.pro.frame-dms = 50
|
||||
# bluez5.a2dp.opus.pro.bidi.channels = 1
|
||||
# bluez5.a2dp.opus.pro.bidi.coupled-streams = 0
|
||||
# bluez5.a2dp.opus.pro.bidi.locations = "FC"
|
||||
# bluez5.a2dp.opus.pro.bidi.locations = [ FC ]
|
||||
# bluez5.a2dp.opus.pro.bidi.max-bitrate = 160000
|
||||
# bluez5.a2dp.opus.pro.bidi.frame-dms = 400
|
||||
}
|
||||
@@ -88,24 +88,11 @@ monitor.bluez-midi.servers = [
|
||||
monitor.bluez.rules = [
|
||||
## The list of monitor rules
|
||||
|
||||
## The following are the default rules applied if none overrides them.
|
||||
# {
|
||||
# matches = [
|
||||
# {
|
||||
# device.name = "~bluez_card.*"
|
||||
# }
|
||||
# ]
|
||||
# actions = {
|
||||
# update-props = {
|
||||
# }
|
||||
# }
|
||||
# }
|
||||
|
||||
## This rule example allows changing properties on all Bluetooth devices.
|
||||
# {
|
||||
# matches = [
|
||||
# {
|
||||
# ## This matches all cards.
|
||||
# ## This matches all bluetooth devices.
|
||||
# device.name = "~bluez_card.*"
|
||||
# }
|
||||
# ]
|
||||
@@ -114,10 +101,10 @@ monitor.bluez.rules = [
|
||||
# ## Auto-connect device profiles on start up or when only partial
|
||||
# ## profiles have connected. Disabled by default if the property
|
||||
# ## is not specified.
|
||||
# bluez5.auto-connect = "[ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]"
|
||||
# bluez5.auto-connect = [ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]
|
||||
#
|
||||
# ## Hardware volume control (default: [ hfp_ag hsp_ag a2dp_source ])
|
||||
# bluez5.hw-volume = "[ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]"
|
||||
# bluez5.hw-volume = [ hfp_hf hsp_hs a2dp_sink hfp_ag hsp_ag a2dp_source ]
|
||||
#
|
||||
# ## LDAC encoding quality
|
||||
# ## Available values: auto (Adaptive Bitrate, default)
|
||||
@@ -171,7 +158,7 @@ monitor.bluez.rules = [
|
||||
]
|
||||
|
||||
monitor.bluez-midi.rules = [
|
||||
## The list of monitor MIDI rules
|
||||
## The list of MIDI monitor rules
|
||||
|
||||
## This rule example allows changing properties on all Bluetooth MIDI nodes.
|
||||
# {
|
||||
@@ -179,7 +166,7 @@ monitor.bluez-midi.rules = [
|
||||
# ## Matches all bluez midi nodes.
|
||||
# {
|
||||
# ## Matches all sources.
|
||||
# node.name = "~bluez_midi*"
|
||||
# node.name = "~bluez_midi.*"
|
||||
# }
|
||||
# ]
|
||||
# actions = {
|
||||
@@ -189,7 +176,6 @@ monitor.bluez-midi.rules = [
|
||||
# priority.session = 100
|
||||
# node.pause-on-idle = false
|
||||
# session.suspend-timeout-seconds = 5
|
||||
# monitor.channel-volumes = false
|
||||
# node.latency-offset-msec = 0
|
||||
# }
|
||||
# }
|
||||
|
||||
Reference in New Issue
Block a user