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>-n | --client-name</opt><arg>=NAME</arg></p>
  88
  89       <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
  90     </option>
  91
  92     <option>
  93       <p><opt>--stream-name</opt><arg>=NAME</arg></p>
  94
  95       <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
  96     </option>
  97
  98     <option>
  99       <p><opt>--volume</opt><arg>=VOLUME</arg></p>
 100
 101       <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
 102     </option>
 103
 104     <option>
 105       <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
 106
 107       <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
 108     </option>
 109
 110     <option>
 111       <p><opt>--format</opt><arg>=FORMAT</arg></p>
 112
 113       <optdesc><p>Capture or play back audio with the specified sample
 114       format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
 115       <opt>s16be</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
 116       <opt>float32le</opt>, <opt>float32be</opt>, <opt>ulaw</opt>,
 117       <opt>alaw</opt>, <opt>s32le</opt>, <opt>s32be</opt>,
 118       <opt>s24le</opt>, <opt>s24be</opt>, <opt>s24-32le</opt>,
 119       <opt>s24-32be</opt>. Depending on the endianess of the CPU the
 120       formats <opt>s16ne</opt>, <opt>s16re</opt>, <opt>s32ne</opt>,
 121       <opt>s32re</opt>, <opt>float32ne</opt>, <opt>float32re</opt>,
 122       <opt>s32ne</opt>, <opt>s32re</opt>, <opt>s24ne</opt>,
 123       <opt>s24re</opt>, <opt>s24-32ne</opt>, <opt>s24-32re</opt> (for
 124       native, resp. reverse endian) are available as aliases. Defaults
 125       to s16ne.</p></optdesc>
 126     </option>
 127
 128     <option>
 129       <p><opt>--channels</opt><arg>=CHANNELS</arg></p>
 130
 131       <optdesc><p>Capture or play back audio with the specified number
 132       of channels. If more than two channels are used it is
 133       recommended to use the <opt>--channel-map</opt> option
 134       below. Defaults to 2.</p></optdesc>
 135     </option>
 136
 137     <option>
 138       <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
 139
 140       <optdesc><p>Explicitly choose a channel map when playing back
 141       this stream. The argument should be a comma separated list of
 142       channel names: <opt>front-left</opt>, <opt>front-right</opt>,
 143       <opt>mono</opt>, <opt>front-center</opt>, <opt>rear-left</opt>,
 144       <opt>rear-right</opt>, <opt>rear-center</opt>, <opt>lfe</opt>,
 145       <opt>front-left-of-center</opt>,
 146       <opt>front-right-of-center</opt>, <opt>side-left</opt>,
 147       <opt>side-right</opt>, <opt>top-center</opt>,
 148       <opt>top-front-center</opt>, <opt>top-front-left</opt>,
 149       <opt>top-front-right</opt>, <opt>top-rear-left</opt>,
 150       <opt>top-rear-right</opt>, <opt>top-rear-center</opt>, or any of
 151       the 32 auxiliary channel names <opt>aux0</opt> to
 152       <opt>aux31</opt>.</p></optdesc>
 153     </option>
 154
 155     <option>
 156       <p><opt>--fix-format</opt></p>
 157       <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>
 158     </option>
 159
 160     <option>
 161       <p><opt>--fix-rate</opt></p>
 162       <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>
 163     </option>
 164
 165     <option>
 166       <p><opt>--fix-channels</opt></p>
 167       <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>
 168     </option>
 169
 170     <option>
 171       <p><opt>--no-remix</opt></p>
 172       <optdesc><p>Never upmix or downmix channels.</p></optdesc>
 173     </option>
 174
 175     <option>
 176       <p><opt>--no-remap</opt></p>
 177       <optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
 178     </option>
 179
 180     <option>
 181       <p><opt>--latency</opt><arg>=BYTES</arg></p>
 182       <optdesc><p>Explicitly configure the latency, with a time
 183       specified in bytes in the selected sample format. If left out
 184       the server will pick the latency, usually relatively high for
 185       power saving reasons. Use either this option or
 186       <opt>--latency-msec</opt>, but not both.</p></optdesc>
 187     </option>
 188
 189     <option>
 190       <p><opt>--latency-msec</opt><arg>=MSEC</arg></p>
 191       <optdesc><p>Explicitly configure the latency, with a time
 192       specified in miliseconds. If left out the server will pick the
 193       latency, usually relatively high for power saving reasons. Use
 194       either this option or <opt>--latency</opt>, but not
 195       both.</p></optdesc>
 196     </option>
 197
 198     <option>
 199       <p><opt>--process-time</opt><arg>=BYTES</arg></p>
 200       <optdesc><p>Explicitly configure the process time, with a time
 201       specified in bytes in the selected sample format. If left out
 202       the server will pick the process time. Use either this option or
 203       <opt>--process-time-msec</opt>, but not both.</p></optdesc>
 204     </option>
 205
 206     <option>
 207       <p><opt>--process-time-msec</opt><arg>=MSEC</arg></p>
 208       <optdesc><p>Explicitly configure the process time, with a time
 209       specified in miliseconds. If left out the server will pick the
 210       process time. Use either this option or <opt>--process-time</opt>,
 211       but not both.</p></optdesc>
 212     </option>
 213
 214     <option>
 215       <p><opt>--property</opt><arg>=PROPERTY=VALUE</arg></p>
 216       <optdesc><p>Attach a property to the client and stream. May be
 217       used multiple times</p></optdesc>
 218     </option>
 219
 220     <option>
 221       <p><opt>--raw</opt></p>
 222       <optdesc><p>Play/record raw audio data. This is the default if
 223       this program is invoked as <cmd>pacat</cmd>, <cmd>parec</cmd> or
 224       <cmd>pamon</cmd>.</p></optdesc>
 225     </option>
 226
 227     <option>
 228       <p><opt>--file-format</opt><arg>[=FFORMAT]</arg></p>
 229       <optdesc><p>Play/record encoded audio data in the file format
 230       specified. This is the default if this program is invoked as
 231       <cmd>paplay</cmd> and <cmd>parecord</cmd>.</p></optdesc>
 232     </option>
 233
 234     <option>
 235       <p><opt>--list-file-formats</opt></p>
 236       <optdesc><p>List supported file formats.</p></optdesc>
 237     </option>
 238
 239   </options>
 240
 241   <section name="Authors">
 242     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 243   </section>
 244
 245   <section name="See also">
 246     <p>
 247       <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>
 248     </p>
 249   </section>
 250
 251 </manpage>