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

man: complete pw-cat man page

Browse source
This commit is contained in:
Wim Taymans 2020-05-05 12:30:37 +02:00
parent 283d7f6e9b
commit 8adc4ad3b6
1 changed files with 109 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

110
man/pw-cat.1.xml.in
View file

@ -45,7 +45,7 @@ This file is part of PipeWire.
<p><opt>-R | --remote</opt><arg>=NAME</arg></p> <p><opt>-R | --remote</opt><arg>=NAME</arg></p>
<optdesc><p>The name the remote instance to connect to. If left unspecified, <optdesc><p>The name the remote instance to connect to. If left unspecified,
a connection is made to the default PipeWire instance.</p></optdesc> a connection is made to the default PipeWire instance.</p></optdesc>
</option> </option>
<option> <option>
<p><opt>-p | --playback</opt></p> <p><opt>-p | --playback</opt></p>
@ -62,6 +62,114 @@ This file is part of PipeWire.
<optdesc><p>Midi mode. FILE is a midi file. If the tool is called under the name <file>pw-midiplay</file> or <file>pw-midirecord</file> this is the default.</p></optdesc> <optdesc><p>Midi mode. FILE is a midi file. If the tool is called under the name <file>pw-midiplay</file> or <file>pw-midirecord</file> this is the default.</p></optdesc>
</option> </option>
<option>
<p><opt>--media-type</opt><arg>=VALUE</arg></p>
<optdesc><p>Set the media type property (default Audio/Midi depending on mode).
The media type is used by the session manager to select a suitable target
to link to.</p></optdesc>
</option>
<option>
<p><opt>--media-category</opt><arg>=VALUE</arg></p>
<optdesc><p>Set the media category property (default Playback/Capture depending on mode).
The media type is used by the session manager to select a suitable target
to link to.</p></optdesc>
</option>
<option>
<p><opt>--media-role</opt><arg>=VALUE</arg></p>
<optdesc><p>Set the media role property (default Music).
The media type is used by the session manager to select a suitable target
to link to.</p></optdesc>
</option>
<option>
<p><opt>--target</opt><arg>=VALUE</arg></p>
<optdesc><p>Set a node target (default auto). The value can be:
<opt>auto</opt>: <optdesc>Automatically select (Default)</optdesc>,
<opt>0</opt>: <optdesc>Don't try to link this node</optdesc>,
<opt>&lt;id&gt;</opt>: <optdesc>The id of a target node</optdesc>
</p></optdesc>
</option>
<option>
<p><opt>--latency</opt><arg>=VALUE[units]</arg></p>
<optdesc><p>Set the node latency (default 100ms)</p>
<p>The latency determines the minimum amount of time it takes
for a sample to travel from application to device (playback) and
from device to application (capture).</p>
<p>The latency determines the size of the buffers that the
application will be able to fill. Lower latency means smaller
buffers but higher overhead. Higher latency means larger buffers
and lower overhead.</p>
<p>Units can be <opt>s</opt> for seconds, <opt>ms</opt> for milliseconds,
<opt>us</opt> for microseconds, <opt>ns</opt> for nanoseconds.
If no units are given, the latency value is samples with the samplerate
of the file.</p>
</optdesc>
</option>
<option>
<p><opt>--list-targets</opt></p>
<optdesc><p>List the available targets for <opt>--target</opt></p>
</optdesc>
</option>
<option>
<p><opt>-q | --quality</opt><arg>=VALUE</arg></p>
<optdesc><p>Resampler quality. When the samplerate of the source or
destination file does not match the samplerate of the server, the
data will be resampled. Higher quality uses more CPU. Values between 0 and 15 are
allowed, the default quality is 4.</p>
</optdesc>
</option>
<option>
<p><opt>--rate</opt><arg>=VALUE</arg></p>
<optdesc><p>The sample rate, default 48000.</p>
</optdesc>
</option>
<option>
<p><opt>--channels</opt><arg>=VALUE</arg></p>
<optdesc><p>The number of channels, default 2.</p>
</optdesc>
</option>
<option>
<p><opt>--channel-map</opt><arg>=VALUE</arg></p>
<optdesc><p>The channelmap. Possible values include:
<opt>mono</opt>, <opt>stereo</opt>, <opt>surround-21</opt>,
<opt>quad</opt>, <opt>surround-22</opt>, <opt>surround-40</opt>,
<opt>surround-31</opt>, <opt>surround-41</opt>,
<opt>surround-50</opt>, <opt>surround-51</opt>,
<opt>surround-51r</opt>, <opt>surround-70</opt>,
<opt>surround-71</opt> or a comma separated list of channel names:
<opt>FL</opt>, <opt>FR</opt>, <opt>FC</opt>, <opt>LFE</opt>,
<opt>SL</opt>, <opt>SR</opt>, <opt>FLC</opt>, <opt>FRC</opt>,
<opt>RC</opt>, <opt>RL</opt>, <opt>RR</opt>, <opt>TC</opt>,
<opt>TFL</opt>, <opt>TFC</opt>, <opt>TFR</opt>, <opt>TRL</opt>,
<opt>TRC</opt>, <opt>TRR</opt>, <opt>RLC</opt>, <opt>RRC</opt>,
<opt>FLW</opt>, <opt>FRW</opt>, <opt>LFE2</opt>, <opt>FLH</opt>,
<opt>FCH</opt>, <opt>FRH</opt>, <opt>TFLC</opt>, <opt>TFRC</opt>,
<opt>TSL</opt>, <opt>TSR</opt>, <opt>LLFR</opt>, <opt>RLFE</opt>,
<opt>BC</opt>, <opt>BLC</opt>, <opt>BRC</opt></p>
</optdesc>
</option>
<option>
<p><opt>--format</opt><arg>=VALUE</arg></p>
<optdesc><p>The sample format to use. One of:
<opt>s8</opt>, <opt>s16</opt> (default), <opt>s24</opt>, <opt>s32</opt>,
<opt>f32</opt>, <opt>f64</opt>.</p>
</optdesc>
</option>
<option>
<p><opt>--volume</opt><arg>=VALUE</arg></p>
<optdesc><p>The stream volume, default 1.000.</p>
</optdesc>
</option>
</options> </options>
<section name="Authors"> <section name="Authors">