<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
-<!-- $Id$ -->
-
<!--
This file is part of PulseAudio.
USA.
-->
-<manpage name="pacat" section="1" desc="Play back or record raw audio streams on a PulseAudio sound server">
+<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>paplay <opt>--help</opt></cmd>
- <cmd>paplay <opt>--version</opt></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 audio files on a PulseAudio sound server.</p>
+ capturing raw or encoded audio files on a PulseAudio sound
+ server.</p>
</description>
<options>
<option>
<p><opt>-r | --record</opt></p>
- <optdesc><p>Capture raw 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>
+ <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 raw 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>
+ <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>
<optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
</option>
+ <option>
+ <p><opt>--monitor-stream</opt><arg>=INDEX</arg></p>
+
+ <optdesc><p>Record from the sink input with index INDEX.</p></optdesc>
+ </option>
+
<option>
<p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
<p><opt>--format</opt><arg>=FORMAT</arg></p>
<optdesc><p>Capture or play back audio with the specified sample
- format. Specify one of <arg>u8</arg>, <arg>s16le</arg>,
- <arg>s16be</arg>, <arg>float32le</arg>, <arg>float32be</arg>,
- <arg>ulaw</arg>, <arg>alaw</arg>. Depending on the endianess of
- the CPU the formats <arg>s16ne</arg>, <arg>s16re</arg>,
- <arg>float32ne</arg>, <arg>float32re</arg> (for native,
- resp. reverse endian) are available as aliases. Defaults to
- s16ne.</p></optdesc>
+ 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>
<optdesc><p>Explicitly choose a channel map when playing back
this stream. The argument should be a comma separated list of
- channel names: <arg>front-left</arg>, <arg>front-right</arg>,
- <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
- <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
- <arg>front-left-of-center</arg>,
- <arg>front-right-of-center</arg>, <arg>side-left</arg>,
- <arg>side-right</arg>, <arg>top-center</arg>,
- <arg>top-front-center</arg>, <arg>top-front-left</arg>,
- <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
- <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
- the 32 auxiliary channel names <arg>aux0</arg> to
- <arg>aux31</arg>.</p></optdesc>
+ 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 milliseconds. 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="See also">
<p>
- <manref name="pulseaudio" section="1"/>, <manref name="paplay" section="1"/>
+ <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>
</p>
</section>