mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2026-06-29 13:14:14 -04:00
Doc: fix some formatting and syntax issues
In pipewire-props.7.md changed ALSA-specific audio.* entries from @PAR@ node-prop to plain \par to eliminate duplicate section label anchors.
This commit is contained in:
parent
f1658434be
commit
07955ff312
3 changed files with 11 additions and 14 deletions
|
|
@ -1021,22 +1021,22 @@ can be found as the name property in the EnumRoute param of the device.
|
|||
|
||||
## Node properties
|
||||
|
||||
@PAR@ node-prop audio.channels # integer
|
||||
\par audio.channels # integer
|
||||
The number of audio channels to open the device with. Defaults depends on the profile of the device.
|
||||
|
||||
@PAR@ node-prop audio.rate # integer
|
||||
\par audio.rate # integer
|
||||
The audio rate to open the device with. Default is 0, which means to open the device with a rate as close to the graph rate as possible.
|
||||
|
||||
@PAR@ node-prop audio.format # string
|
||||
\par audio.format # string
|
||||
The audio format to open the device in. By default this is "UNKNOWN", which will open the device in the best possible bits (32/24/16/8..). You can force a format like S16_LE or S32_LE.
|
||||
|
||||
@PAR@ node-prop audio.position # JSON array of strings
|
||||
\par audio.position # JSON array of strings
|
||||
The audio position of the channels in the device. This is auto detected based on the profile. You can configure an array of channel positions, like "[ FL, FR ]".
|
||||
|
||||
@PAR@ node-prop audio.layout # string
|
||||
\par audio.layout # string
|
||||
The audio layout of the channels in the device. You can use any of the predefined layouts, like "Stereo", "5.1" etc.
|
||||
|
||||
@PAR@ node-prop audio.allowed-rates # JSON array of integers
|
||||
\par audio.allowed-rates # JSON array of integers
|
||||
\parblock
|
||||
The allowed audio rates to open the device with. Default is "[ ]", which means the device can be opened in any supported rate.
|
||||
|
||||
|
|
@ -1620,7 +1620,7 @@ For ACP, PipeWire looks for the profile configuration files under
|
|||
|
||||
- ~/.config/alsa-card-profile
|
||||
- /etc/alsa-card-profile
|
||||
- /usr/share/alsa-card-profile/mixer`.
|
||||
- /usr/share/alsa-card-profile/mixer.
|
||||
|
||||
The `path` and `profile-set` files are in subdirectories `paths` and `profile-sets` of these directories.
|
||||
It is possible to override individual files locally by putting a modified copy into the ACP directories under `~/.config` or `/etc`.
|
||||
|
|
|
|||
|
|
@ -352,10 +352,10 @@ rectangles. For example
|
|||
After having received the first \ref SPA_PARAM_PeerCapability param, if it contained the
|
||||
\ref PW_CAPABILITY_DEVICE_ID_NEGOTIATION set to a supported API version number, the full
|
||||
set of formats can be sent using \ref pw_stream_update_params following by activating the
|
||||
stream usina supported API version numberstream_set_active(stream, true)`.
|
||||
stream using `pw_stream_set_active(stream, true)`.
|
||||
|
||||
Note that the first \ref SPA_PARAM_Format received may be the result of the initial format
|
||||
negotian with bare minimum parameters, and will be superseded by the result of the format
|
||||
negotiation with bare minimum parameters, and will be superseded by the result of the format
|
||||
negotiation of the later provided format parameters.
|
||||
|
||||
## Device subset capability
|
||||
|
|
|
|||
|
|
@ -200,7 +200,7 @@ Sink runnable, for example by linking a playback node:
|
|||
+----------+ +--------+ +--------+
|
||||
```
|
||||
|
||||
The input port of the filter is `port.passive = follow-suspend' and so it can be
|
||||
The input port of the filter is `port.passive = follow-suspend` and so it can be
|
||||
activated by the playback node.
|
||||
|
||||
Likewise, if the ALSA Sink is runnable, it should not automatically make the
|
||||
|
|
@ -381,13 +381,10 @@ This is done by setting the same node.sync-group property on all nodes (by defau
|
|||
nodes have `node.sync-group = group.sync.0`). When a node sets `node.sync = true` all
|
||||
the other nodes with the same `node.sync-group` property are grouped together.
|
||||
|
||||
This can be used to implement the JACK transport. When the transport is started, the
|
||||
This can be used to implement the JACK transport. When the transport is started, the
|
||||
`node.sync=true` property is set and all nodes join one group with a shared driver
|
||||
and timing information.
|
||||
|
||||
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue