mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add more properties missing from docs

Browse source
This commit is contained in:
Pauli Virtanen 2025-09-02 20:02:25 +03:00 • committed by Wim Taymans
parent 36871ff1ff
commit 0f1e4f8706
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/dox/config/pipewire-props.7.md
View file

@ -744,6 +744,9 @@ See \ref spa_param_port_config for the meaning.
Use \ref monitor-prop__alsa_card_profiles "ALSA Card Profiles" (ACP) for device configuration.
This autodetects available ALSA devices and configures port and hardware mixers.
@PAR@ monitor-prop alsa.use-ucm # boolean
Enable or disable UCM for all devices. Default: unset.
@PAR@ monitor-prop alsa.udev.expose-busy # boolean
Expose the ALSA card even if it is busy/in use. Default false. This can be useful when some
of the PCMs are in use by other applications but the other free PCMs should still be exposed.
@ -898,12 +901,18 @@ Static set the device systemic latency, in nanoseconds.
@PAR@ node-prop api.alsa.path # string
UNDOCUMENTED
@PAR@ node-prop api.alsa.pcm.card # integer
Card index to open. Usually determined from `api.alsa.path`.
@PAR@ node-prop api.alsa.open.ucm # boolean
Open device using UCM.
@PAR@ node-prop api.alsa.bind-ctls # boolean
UNDOCUMENTED
@PAR@ node-prop api.alsa.bind-ctl.NAME # boolean
UNDOCUMENTED
@PAR@ node-prop iec958.codecs # JSON array of string
Enable only specific IEC958 codecs. This can be used to disable some codecs the hardware supports.
Available values: PCM, AC3, DTS, MPEG, MPEG2-AAC, EAC3, TRUEHD, DTSHD
@ -925,6 +934,9 @@ Informative property.
Informative property.
\endparblock
@PAR@ node-prop api.alsa.dsd-lsb = false # boolean
Use LSB bit order for DSD audio output.
# ALSA MIDI PROPERTIES @IDX@ props
@ -937,8 +949,10 @@ configured in the monitor properties.
Use MIDI 2.0 if possible.
@PAR@ monitor-prop api.alsa.seq.min-pool = 500 # integer
UNDOCUMENTED
@PAR@ monitor-prop api.alsa.seq.max-pool = 2000 # integer
UNDOCUMENTED
@PAR@ monitor-prop clock.name = "clock.system.monotonic" # string
Clock to follow.