code.delx.au - pulseaudio/blob - man/pacat.1.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 USA.
  22 -->
  23
  24 <manpage name="pacat" section="1" desc="Play back or record raw or encoded audio streams on a PulseAudio sound server">
  25
  26   <synopsis>
  27     <cmd>paplay [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  28     <cmd>parecord [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  29     <cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  30     <cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  31     <cmd>pamon [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
  32     <cmd>pacat <opt>--help</opt></cmd>
  33     <cmd>pacat <opt>--version</opt></cmd>
  34   </synopsis>
  35
  36   <description>
  37     <p><file>pacat</file> is a simple tool for playing back or
  38     capturing raw or encoded audio files on a PulseAudio sound
  39     server.</p>
  40   </description>
  41
  42   <options>
  43
  44     <option>
  45       <p><opt>-h | --help</opt></p>
  46
  47       <optdesc><p>Show help.</p></optdesc>
  48     </option>
  49
  50     <option>
  51       <p><opt>--version</opt></p>
  52
  53       <optdesc><p>Show version information.</p></optdesc>
  54     </option>
  55
  56     <option>
  57       <p><opt>-r | --record</opt></p>
  58
  59       <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>
  60     </option>
  61
  62     <option>
  63       <p><opt>-p | --playback</opt></p>
  64
  65       <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>
  66     </option>
  67
  68     <option>
  69       <p><opt>-v | --verbose</opt></p>
  70
  71       <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</p></optdesc>
  72     </option>
  73
  74     <option>
  75       <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
  76
  77       <optdesc><p>Choose the server to connect to.</p></optdesc>
  78     </option>
  79
  80     <option>
  81       <p><opt>-d | --device</opt><arg>=SINKORSOURCE</arg></p>
  82
  83       <optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
  84     </option>
  85
  86     <option>
  87       <p><opt>--monitor-stream</opt><arg>=INDEX</arg></p>
  88
  89       <optdesc><p>Record from the sink input with index INDEX.</p></optdesc>
  90     </option>
  91
  92     <option>
  93       <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
  94
  95       <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
  96     </option>
  97
  98     <option>
  99       <p><opt>--stream-name</opt><arg>=NAME</arg></p>
 100
 101       <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
 102     </option>
 103
 104     <option>
 105       <p><opt>--volume</opt><arg>=VOLUME</arg></p>
 106
 107       <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
 108     </option>
 109
 110     <option>
 111       <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
 112
 113       <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
 114     </option>
 115
 116     <option>
 117       <p><opt>--format</opt><arg>=FORMAT</arg></p>
 118
 119       <optdesc><p>Capture or play back audio with the specified sample
 120       format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
 121       <opt>s16be</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
 122       <opt>float32le</opt>, <opt>float32be</opt>, <opt>ulaw</opt>,
 123       <opt>alaw</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
 124       <opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
 125       <opt>s24-32be</opt>. Depending on the endianness of the CPU the
 126       formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>,
 127       <opt>s32re</opt>, <opt>float32ne</opt>, <opt>float32re</opt>,
 128       <opt>s32ne</opt>, <opt>s32re</opt>, <opt>s24ne</opt>,
 129       <opt>s24re</opt>, <opt>s24-32ne</opt>, <opt>s24-32re</opt> (for
 130       native, resp. reverse endian) are available as aliases. Defaults
 131       to s16ne.</p></optdesc>
 132     </option>
 133
 134     <option>
 135       <p><opt>--channels</opt><arg>=CHANNELS</arg></p>
 136
 137       <optdesc><p>Capture or play back audio with the specified number
 138       of channels. If more than two channels are used it is
 139       recommended to use the <opt>--channel-map</opt> option
 140       below. Defaults to 2.</p></optdesc>
 141     </option>
 142
 143     <option>
 144       <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
 145
 146       <optdesc><p>Explicitly choose a channel map when playing back
 147       this stream. The argument should be a comma separated list of
 148       channel names: <opt>front-left</opt>, <opt>front-right</opt>,
 149       <opt>mono</opt>, <opt>front-center</opt>, <opt>rear-left</opt>,
 150       <opt>rear-right</opt>, <opt>rear-center</opt>, <opt>lfe</opt>,
 151       <opt>front-left-of-center</opt>,
 152       <opt>front-right-of-center</opt>, <opt>side-left</opt>,
 153       <opt>side-right</opt>, <opt>top-center</opt>,
 154       <opt>top-front-center</opt>, <opt>top-front-left</opt>,
 155       <opt>top-front-right</opt>, <opt>top-rear-left</opt>,
 156       <opt>top-rear-right</opt>, <opt>top-rear-center</opt>, or any of
 157       the 32 auxiliary channel names <opt>aux0</opt> to
 158       <opt>aux31</opt>.</p></optdesc>
 159     </option>
 160
 161     <option>
 162       <p><opt>--fix-format</opt></p>
 163       <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>
 164     </option>
 165
 166     <option>
 167       <p><opt>--fix-rate</opt></p>
 168       <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>
 169     </option>
 170
 171     <option>
 172       <p><opt>--fix-channels</opt></p>
 173       <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>
 174     </option>
 175
 176     <option>
 177       <p><opt>--no-remix</opt></p>
 178       <optdesc><p>Never upmix or downmix channels.</p></optdesc>
 179     </option>
 180
 181     <option>
 182       <p><opt>--no-remap</opt></p>
 183       <optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
 184     </option>
 185
 186     <option>
 187       <p><opt>--latency</opt><arg>=BYTES</arg></p>
 188       <optdesc><p>Explicitly configure the latency, with a time
 189       specified in bytes in the selected sample format. If left out
 190       the server will pick the latency, usually relatively high for
 191       power saving reasons. Use either this option or
 192       <opt>--latency-msec</opt>, but not both.</p></optdesc>
 193     </option>
 194
 195     <option>
 196       <p><opt>--latency-msec</opt><arg>=MSEC</arg></p>
 197       <optdesc><p>Explicitly configure the latency, with a time
 198       specified in milliseconds. If left out the server will pick the
 199       latency, usually relatively high for power saving reasons. Use
 200       either this option or <opt>--latency</opt>, but not
 201       both.</p></optdesc>
 202     </option>
 203
 204     <option>
 205       <p><opt>--process-time</opt><arg>=BYTES</arg></p>
 206       <optdesc><p>Explicitly configure the process time, with a time
 207       specified in bytes in the selected sample format. If left out
 208       the server will pick the process time. Use either this option or
 209       <opt>--process-time-msec</opt>, but not both.</p></optdesc>
 210     </option>
 211
 212     <option>
 213       <p><opt>--process-time-msec</opt><arg>=MSEC</arg></p>
 214       <optdesc><p>Explicitly configure the process time, with a time
 215       specified in miliseconds. If left out the server will pick the
 216       process time. Use either this option or <opt>--process-time</opt>,
 217       but not both.</p></optdesc>
 218     </option>
 219
 220     <option>
 221       <p><opt>--property</opt><arg>=PROPERTY=VALUE</arg></p>
 222       <optdesc><p>Attach a property to the client and stream. May be
 223       used multiple times</p></optdesc>
 224     </option>
 225
 226     <option>
 227       <p><opt>--raw</opt></p>
 228       <optdesc><p>Play/record raw audio data. This is the default if
 229       this program is invoked as <cmd>pacat</cmd>, <cmd>parec</cmd> or
 230       <cmd>pamon</cmd>.</p></optdesc>
 231     </option>
 232
 233     <option>
 234       <p><opt>--file-format</opt><arg>[=FFORMAT]</arg></p>
 235       <optdesc><p>Play/record encoded audio data in the file format
 236       specified. This is the default if this program is invoked as
 237       <cmd>paplay</cmd> and <cmd>parecord</cmd>.</p></optdesc>
 238     </option>
 239
 240     <option>
 241       <p><opt>--list-file-formats</opt></p>
 242       <optdesc><p>List supported file formats.</p></optdesc>
 243     </option>
 244
 245   </options>
 246
 247   <section name="Authors">
 248     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 249   </section>
 250
 251   <section name="See also">
 252     <p>
 253       <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>
 254     </p>
 255   </section>
 256
 257 </manpage>