mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: some updates

Browse source
This commit is contained in:
Wim Taymans 2024-02-20 13:29:36 +01:00
parent 539fdc5477
commit 18aeddbe80
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/dox/config/pipewire-client.conf.5.md
View file

@ -77,6 +77,7 @@ stream.properties = {
#channelmix.min-volume = 0.0 #channelmix.min-volume = 0.0
#channelmix.max-volume = 10.0 #channelmix.max-volume = 10.0
#channelmix.normalize = false #channelmix.normalize = false
#channelmix.lock-volume = false
#channelmix.mix-lfe = true #channelmix.mix-lfe = true
#channelmix.upmix = true #channelmix.upmix = true
#channelmix.upmix-method = psd # none, simple #channelmix.upmix-method = psd # none, simple
@ -379,6 +380,9 @@ While this options prevents clipping, it can in some cases produce too low volum
volume in that case or disable normalization. volume in that case or disable normalization.
\endparblock \endparblock
@PAR@ client.conf channelmix.lock-volumes = false
Completely disable volume or mute changes. Defaults to false.
@PAR@ client.conf channelmix.mix-lfe = true @PAR@ client.conf channelmix.mix-lfe = true
Mixes the low frequency effect channel into the front center or stereo pair. This might enhance the dynamic range of the signal if there is no subwoofer and the speakers can reproduce the low frequency signal. Mixes the low frequency effect channel into the front center or stereo pair. This might enhance the dynamic range of the signal if there is no subwoofer and the speakers can reproduce the low frequency signal.

6
doc/dox/config/pipewire-devices.7.md
View file

@ -179,7 +179,7 @@ for explanations.
\ref client_conf__channelmix_upmix-method "See pipewire-client.conf(5)" \ref client_conf__channelmix_upmix-method "See pipewire-client.conf(5)"
@PAR@ device-param channelmix.lock-volumes @PAR@ device-param channelmix.lock-volumes
UNDOCUMENTED \ref client_conf__channelmix_lock-volumes "See pipewire-client.conf(5)"
@PAR@ device-param resample.quality @PAR@ device-param resample.quality
\ref client_conf__resample_quality "See pipewire-client.conf(5)" \ref client_conf__resample_quality "See pipewire-client.conf(5)"
@ -251,10 +251,10 @@ Disable mmap operation of the device and use the ALSA read/write API instead. De
Ignore the ALSA batch flag. If the batch flag is set, ALSA will need an extra period to update the read/write pointers. Ignore this flag from ALSA can reduce the latency. Default is false. Ignore the ALSA batch flag. If the batch flag is set, ALSA will need an extra period to update the read/write pointers. Ignore this flag from ALSA can reduce the latency. Default is false.
@PAR@ device-param api.alsa.use-chmap @PAR@ device-param api.alsa.use-chmap
Use the driver provided channel map. Default is true. Use the driver provided channel map. Default is true when using UCM, false otherwise because many driver don't report this correctly.
@PAR@ device-param api.alsa.multi-rate @PAR@ device-param api.alsa.multi-rate
UNDOCUMENTED Allow devices from the same card to be opened in multiple sample rates. Default is true. Some older drivers did not properly advertize the capabilities of the device and only really supported opening the device in one rate.
@PAR@ device-param api.alsa.htimestamp = false @PAR@ device-param api.alsa.htimestamp = false
Use ALSA htimestamps in scheduling, instead of the system clock. Use ALSA htimestamps in scheduling, instead of the system clock.