mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2026-03-13 05:33:55 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: document some more audioconvert properties

Browse source
This commit is contained in:
Pauli Virtanen 2024-05-06 18:16:07 +03:00
parent 6ab10237cd
commit 1717b1bebc
1 changed files with 23 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -189,11 +189,14 @@ for explanations.
@PAR@ device-param resample.disable @PAR@ device-param resample.disable
\ref client_conf__resample_disable "See pipewire-client.conf(5)" \ref client_conf__resample_disable "See pipewire-client.conf(5)"
@PAR@ device-param resample.peaks @PAR@ device-param resample.peaks = false # boolean
UNDOCUMENTED Instead of actually resampling, produce peak amplitude values as output.
This is used for volume monitoring, where it is set as a property
of the "recording" stream.
@PAR@ device-param resample.prefill @PAR@ device-param resample.prefill = false # boolean
UNDOCUMENTED Prefill resampler buffers with silence. This affects the initial
samples produced by the resampler.
@PAR@ device-param monitor.channel-volumes @PAR@ device-param monitor.channel-volumes
\ref client_conf__monitor_channel-volumes "See pipewire-client.conf(5)" \ref client_conf__monitor_channel-volumes "See pipewire-client.conf(5)"
@ -207,9 +210,23 @@ UNDOCUMENTED
@PAR@ device-param debug.wav-path @PAR@ device-param debug.wav-path
\ref client_conf__debug_wav-path "See pipewire-client.conf(5)" \ref client_conf__debug_wav-path "See pipewire-client.conf(5)"
@PAR@ device-param adapter.auto-port-config @PAR@ device-param adapter.auto-port-config = null # JSON
UNDOCUMENTED \parblock
If specified, configure the ports of the node when it is created, instead of
leaving that to the session manager to do. This is useful (only) for minimal
configurations without a session manager.
Value is SPA JSON of the form:
```json
{
mode = "none", # "none", "passthrough", "convert", "dsp"
monitor = false, # boolean
control = false, # boolean
position = "preserve" # "unknown", "aux", "preserve"
}
```
See \ref spa_param_port_config for the meaning.
\endparblock
# ALSA PROPERTIES @IDX@ device-param # ALSA PROPERTIES @IDX@ device-param