wireplumber.conf: improve settings descriptions

The setting descriptions are in principle user-facing, so try to make
their descriptions more clear.
This commit is contained in:
Pauli Virtanen 2025-07-22 14:35:03 +03:00
parent fb218fe016
commit f6912ec23c

View file

@ -784,36 +784,36 @@ wireplumber.components.rules = [
wireplumber.settings.schema = {
## Bluetooth
bluetooth.use-persistent-storage = {
description = "Whether to use persistent BT storage or not"
description = "Remember and restore Bluetooth headset mode status"
type = "bool"
default = true
}
bluetooth.autoswitch-to-headset-profile = {
description = "Whether to autoswitch to BT headset profile or not"
description = "Always show microphone for Bluetooth headsets, and switch to headset mode when recording"
type = "bool"
default = true
}
## Device
device.restore-profile = {
description = "Whether to restore device profile or not"
description = "Remember and restore device profiles"
type = "bool"
default = true
}
device.restore-routes = {
description = "Whether to restore device routes or not"
description = "Remember and restore device routes"
type = "bool"
default = true
}
device.routes.default-sink-volume = {
description = "The default volume for sink devices"
description = "The default volume for audio sinks"
type = "float"
default = 0.064
min = 0.0
max = 1.0
}
device.routes.default-source-volume = {
description = "The default volume for source devices"
description = "The default volume for audio sources"
type = "float"
default = 1.0
min = 0.0
@ -829,17 +829,17 @@ wireplumber.settings.schema = {
max = 1.0
}
linking.allow-moving-streams = {
description = "Whether to allow metadata to move streams at runtime or not"
description = "Streams may be moved by adding PipeWire metadata at runtime"
type = "bool"
default = true
}
linking.follow-default-target = {
description = "Whether to allow streams follow the default device or not"
description = "Streams connected to the default device follow when default changes"
type = "bool"
default = true
}
linking.pause-playback = {
description = "Whether to pause media players if their target sink is removed"
description = "Pause media players if their target sink is removed"
type = "bool"
default = true
}
@ -855,27 +855,27 @@ wireplumber.settings.schema = {
## Node
node.features.audio.no-dsp = {
description = "Whether to never convert audio to F32 format or not"
description = "Do not convert audio to F32 format"
type = "bool"
default = false
}
node.features.audio.monitor-ports = {
description = "Whether to enable monitor ports on audio nodes or not"
description = "Enable monitor ports on audio nodes"
type = "bool"
default = true
}
node.features.audio.control-port = {
description = "Whether to enable control ports on audio nodes or not"
description = "Enable control ports on audio nodes"
type = "bool"
default = false
}
node.stream.restore-props = {
description = "Whether to restore properties on stream nodes or not"
description = "Remember and restore properties of streams"
type = "bool"
default = true
}
node.stream.restore-target = {
description = "Whether to restore target on stream nodes or not"
description = "Remember and restore stream targets"
type = "bool"
default = true
}
@ -894,17 +894,17 @@ wireplumber.settings.schema = {
max = 1.0
}
node.stream.default-media-role = {
description = "A media.role to assign on streams that have none specified"
description = "Default media.role to assign on streams that do not specify it"
type = "string"
default = null
}
node.filter.forward-format = {
description = "Whether to forward format on filter nodes or not"
description = "Forward format on filter nodes or not"
type = "bool"
default = false
}
node.restore-default-targets = {
description = "Whether to restore default targets or not"
description = "Remember and restore default audio/video input/output devices"
type = "bool"
default = true
}