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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!--
This file is part of PulseAudio.
PulseAudio is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
-->
<manpage name="pacat" section="1" desc="Play back or record raw or encoded audio streams on a PulseAudio sound server">
<synopsis>
<cmd>paplay [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>parecord [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pamon [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
<cmd>pacat <opt>--help</opt></cmd>
<cmd>pacat <opt>--version</opt></cmd>
</synopsis>
<description>
<p><file>pacat</file> is a simple tool for playing back or
capturing raw or encoded audio files on a PulseAudio sound
server.</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>-r | --record</opt></p>
<optdesc><p>Capture audio data and write it to the specified file or to STDOUT if none is specified. If the tool is called under the name <file>parec</file> this is the default.</p></optdesc>
</option>
<option>
<p><opt>-p | --playback</opt></p>
<optdesc><p>Read audio data from the specified file or STDIN if none is specified, and play it back. If the tool is called under the name <file>pacat</file> this is the default.</p></optdesc>
</option>
<option>
<p><opt>-v | --verbose</opt></p>
<optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</p></optdesc>
</option>
<option>
<p><opt>-s | --server</opt><arg>=SERVER</arg></p>
<optdesc><p>Choose the server to connect to.</p></optdesc>
</option>
<option>
<p><opt>-d | --device</opt><arg>=SINKORSOURCE</arg></p>
<optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
</option>
<option>
<p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
<optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
</option>
<option>
<p><opt>--stream-name</opt><arg>=NAME</arg></p>
<optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
</option>
<option>
<p><opt>--volume</opt><arg>=VOLUME</arg></p>
<optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
</option>
<option>
<p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
<optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
</option>
<option>
<p><opt>--format</opt><arg>=FORMAT</arg></p>
<optdesc><p>Capture or play back audio with the specified sample
format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
<opt>s16be</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
<opt>float32le</opt>, <opt>float32be</opt>, <opt>ulaw</opt>,
<opt>alaw</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
<opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
<opt>s24-32be</opt>. Depending on the endianness of the CPU the
formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>,
<opt>s32re</opt>, <opt>float32ne</opt>, <opt>float32re</opt>,
<opt>s32ne</opt>, <opt>s32re</opt>, <opt>s24ne</opt>,
<opt>s24re</opt>, <opt>s24-32ne</opt>, <opt>s24-32re</opt> (for
native, resp. reverse endian) are available as aliases. Defaults
to s16ne.</p></optdesc>
</option>
<option>
<p><opt>--channels</opt><arg>=CHANNELS</arg></p>
<optdesc><p>Capture or play back audio with the specified number
of channels. If more than two channels are used it is
recommended to use the <opt>--channel-map</opt> option
below. Defaults to 2.</p></optdesc>
</option>
<option>
<p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
<optdesc><p>Explicitly choose a channel map when playing back
this stream. The argument should be a comma separated list of
channel names: <opt>front-left</opt>, <opt>front-right</opt>,
<opt>mono</opt>, <opt>front-center</opt>, <opt>rear-left</opt>,
<opt>rear-right</opt>, <opt>rear-center</opt>, <opt>lfe</opt>,
<opt>front-left-of-center</opt>,
<opt>front-right-of-center</opt>, <opt>side-left</opt>,
<opt>side-right</opt>, <opt>top-center</opt>,
<opt>top-front-center</opt>, <opt>top-front-left</opt>,
<opt>top-front-right</opt>, <opt>top-rear-left</opt>,
<opt>top-rear-right</opt>, <opt>top-rear-center</opt>, or any of
the 32 auxiliary channel names <opt>aux0</opt> to
<opt>aux31</opt>.</p></optdesc>
</option>
<option>
<p><opt>--fix-format</opt></p>
<optdesc><p>If passed, the sample format of the stream is changed to the native format of the sink the stream is connected to.</p></optdesc>
</option>
<option>
<p><opt>--fix-rate</opt></p>
<optdesc><p>If passed, the sampling rate of the stream is changed to the native rate of the sink the stream is connected to.</p></optdesc>
</option>
<option>
<p><opt>--fix-channels</opt></p>
<optdesc><p>If passed, the number of channels and the channel map of the stream is changed to the native number of channels and the native channel map of the sink the stream is connected to.</p></optdesc>
</option>
<option>
<p><opt>--no-remix</opt></p>
<optdesc><p>Never upmix or downmix channels.</p></optdesc>
</option>
<option>
<p><opt>--no-remap</opt></p>
<optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
</option>
<option>
<p><opt>--latency</opt><arg>=BYTES</arg></p>
<optdesc><p>Explicitly configure the latency, with a time
specified in bytes in the selected sample format. If left out
the server will pick the latency, usually relatively high for
power saving reasons. Use either this option or
<opt>--latency-msec</opt>, but not both.</p></optdesc>
</option>
<option>
<p><opt>--latency-msec</opt><arg>=MSEC</arg></p>
<optdesc><p>Explicitly configure the latency, with a time
specified in miliseconds. If left out the server will pick the
latency, usually relatively high for power saving reasons. Use
either this option or <opt>--latency</opt>, but not
both.</p></optdesc>
</option>
<option>
<p><opt>--process-time</opt><arg>=BYTES</arg></p>
<optdesc><p>Explicitly configure the process time, with a time
specified in bytes in the selected sample format. If left out
the server will pick the process time. Use either this option or
<opt>--process-time-msec</opt>, but not both.</p></optdesc>
</option>
<option>
<p><opt>--process-time-msec</opt><arg>=MSEC</arg></p>
<optdesc><p>Explicitly configure the process time, with a time
specified in miliseconds. If left out the server will pick the
process time. Use either this option or <opt>--process-time</opt>,
but not both.</p></optdesc>
</option>
<option>
<p><opt>--property</opt><arg>=PROPERTY=VALUE</arg></p>
<optdesc><p>Attach a property to the client and stream. May be
used multiple times</p></optdesc>
</option>
<option>
<p><opt>--raw</opt></p>
<optdesc><p>Play/record raw audio data. This is the default if
this program is invoked as <cmd>pacat</cmd>, <cmd>parec</cmd> or
<cmd>pamon</cmd>.</p></optdesc>
</option>
<option>
<p><opt>--file-format</opt><arg>[=FFORMAT]</arg></p>
<optdesc><p>Play/record encoded audio data in the file format
specified. This is the default if this program is invoked as
<cmd>paplay</cmd> and <cmd>parecord</cmd>.</p></optdesc>
</option>
<option>
<p><opt>--list-file-formats</opt></p>
<optdesc><p>List supported file formats.</p></optdesc>
</option>
</options>
<section name="Authors">
<p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
</section>
<section name="See also">
<p>
<manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>
</p>
</section>
</manpage>
|
