1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!--
This file is part of PipeWire.
-->
<manpage name="pw-cat" section="1" desc="Play an Record media with PipeWire">
<synopsis>
<cmd>pw-cat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pw-play [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pw-record [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pw-midiplay [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pw-midirecord [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
</synopsis>
<description>
<p><file>pw-cat</file> is a simple tool for playing back or
capturing raw or encoded media files on a PipeWire
server. It understands all audio file formats supported by
<file>libsndfile</file>.</p>
</description>
<options>
<option>
<p><opt>-h | --help</opt></p>
<optdesc><p>Show help.</p></optdesc>
</option>
<option>
<p><opt>--version</opt></p>
<optdesc><p>Show version information.</p></optdesc>
</option>
<option>
<p><opt>-v | --verbose</opt></p>
<optdesc><p>Verbose operation.</p></optdesc>
</option>
<option>
<p><opt>-R | --remote</opt><arg>=NAME</arg></p>
<optdesc><p>The name the remote instance to connect to. If left unspecified,
a connection is made to the default PipeWire instance.</p></optdesc>
</option>
<option>
<p><opt>-p | --playback</opt></p>
<optdesc><p>Playback mode. Read data from the specified file, and play it back. If the tool is called under the name <file>pw-play</file> or <file>pw-midiplay</file> this is the default.</p></optdesc>
</option>
<option>
<p><opt>-r | --record</opt></p>
<optdesc><p>Recording mode. Capture data and write it to the specified file. If the tool is called under the name <file>pw-record</file> or <file>pw-midirecord</file> this is the default.</p></optdesc>
</option>
<option>
<p><opt>-m | --midi</opt></p>
<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>
<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><id></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>
<section name="Authors">
<p>The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
</section>
<section name="See also">
<p>
<manref name="pipewire" section="1"/>,
<manref name="pw-mon" section="1"/>,
</p>
</section>
</manpage>
|
