10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13666N/A<!--ARC : LSARC 2002/464 GNOME 2.x sound recorder-->
10139N/A<!ENTITY cmd "play">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<refentry id="play-1">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>play</refentrytitle><manvolnum>1</manvolnum>
10139N/A<refmiscinfo class="date">3 Apr 2003</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
17617N/A<indexterm><primary>play</primary></indexterm>
17617N/A<indexterm><primary>play a sound file</primary></indexterm>
17617N/A<indexterm><primary>rec</primary></indexterm><indexterm>
10139N/A<primary>record audio to a specified sound file format</primary></indexterm>
17617N/A<refnamediv id="play-1-name">
17617N/A<refname>play</refname>
17617N/A<refname>rec</refname>
10139N/A<refpurpose>play a sound file; record audio to a specified sound file format
10139N/A</refpurpose></refnamediv>
10139N/A<refsynopsisdiv id="play-1-synp"><title>&synp-tt;</title>
17617N/A<cmdsynopsis><command>&cmd;</command>
17617N/A<arg choice="opt" rep="repeat"><option role="nodash"><replaceable>option</replaceable></option></arg>
17617N/A<arg choice="plain"><option role="nodash"><replaceable>infile</replaceable></option></arg>
17617N/A<arg choice="opt"><option role="nodash"><replaceable>effect</replaceable></option></arg>
10139N/A</cmdsynopsis>
17617N/A<cmdsynopsis><command>rec</command>
17617N/A<arg choice="opt" rep="repeat"><option role="nodash"><replaceable>option</replaceable></option></arg>
17617N/A<arg choice="plain"><option role="nodash"><replaceable>outfile</replaceable></option></arg>
17617N/A<arg choice="opt"><option role="nodash"><replaceable>effect</replaceable></option></arg>
10139N/A</cmdsynopsis></refsynopsisdiv>
17617N/A
10139N/A<refsect1 id="play-1-desc"><title>&desc-tt;</title>
17617N/A<para>
17617N/A<command>&cmd;</command> and <command>rec</command> allow you to play and
17617N/Arecord different types of sound files from the command line. Both of these
17617N/Acommands use the <command>sox</command> application. Normally, the
17617N/A<command>&cmd;</command> command automatically detects the type and other
17617N/Aparameters of the sound file. If the <command>&cmd;</command> command cannot
17617N/Ado this, you can use the command options to change the parameters.
17617N/A</para>
17617N/A
17617N/A<para>
17617N/AFor both <command>&cmd;</command> and <command>rec</command>,
17617N/A<replaceable>effect</replaceable> can be one of the following:
17617N/A<literal>avg</literal>, <literal>band</literal>, <literal>chorus</literal>,
17617N/A<literal>copy</literal>, <literal>cut</literal>, <literal>deemph</literal>,
17617N/A<literal>echo</literal>, <literal>echos</literal>, <literal>flanger</literal>,
17617N/A<literal>highp</literal>, <literal>lowp</literal>, <literal>map</literal>,
17617N/A<literal>mask</literal>, <literal>phaser</literal>, <literal>pick</literal>,
17617N/A<literal>polyphase</literal>, <literal>rate</literal>,
17617N/A<literal>resample</literal>, <literal>reverb</literal>,
17617N/A<literal>reverse</literal>, <literal>split</literal>, <literal>stat</literal>,
17617N/Aor <literal>vibro</literal>. For more information about these effects, see
17617N/A<citerefentry><refentrytitle>sox</refentrytitle>
17617N/A<manvolnum>1</manvolnum></citerefentry>
17617N/Aand
17617N/A<citerefentry><refentrytitle>soxexam</refentrytitle>
17617N/A<manvolnum>5</manvolnum></citerefentry>.
17617N/A</para>
10139N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-opts"><title>&opts-tt;</title>
17617N/A<para>
17617N/AThe following options are supported for both <command>&cmd;</command> and
17617N/A<command>rec</command>:
17617N/A</para>
17617N/A
17617N/A<variablelist termlength="medium"><varlistentry>
17617N/A<term><option>c</option>, <option>-channels=<replaceable>channels</replaceable></option></term>
17617N/A<listitem><para>
17617N/ADefine the number of channels in the file.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>d</option>, <option>-device=<replaceable>device</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecify the device to which the sound file should be played.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>f</option>, <option>-format=<replaceable>format</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecify the bit format of the sample. The supported values for
17617N/A<replaceable>format</replaceable> are <literal>A</literal>,
17617N/A<literal>a</literal>, <literal>g</literal>, <literal>s</literal>,
17617N/A<literal>U</literal>, or <literal>u</literal>.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>-help</option></term>
17617N/A<listitem><para>
17617N/AShow usage and basic help information.
17617N/A</para>
10139N/A</listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>r</option>, <option>-rate=<replaceable>rate</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecify the sample rate of the audio data, in samples per second.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>s</option>, <option>-size=<replaceable>size</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecify the width of each sample. The supported values for
17617N/A<replaceable>size</replaceable> are <literal>b</literal>, <literal>D</literal>,
17617N/A<literal>d</literal>, <literal>f</literal>, <literal>l</literal>, and
17617N/A<literal>w</literal>.
17617N/A</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term><option>t</option>, <option>-type=<replaceable>type</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecify the audio file format to use. This option is useful if the audio file
17617N/Aformat cannot be automatically determined.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry><term><option>-version</option></term>
17617N/A<listitem><para>
17617N/AShow version information.
17617N/A</para>
10139N/A</listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>v</option>, <option>-volume=<replaceable>volume</replaceable></option></term>
17617N/A<listitem><para>
17617N/AChange the audio volume.
17617N/A</para>
10139N/A</listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option>x</option>, <option>-xinu</option></term>
17617N/A<listitem><para>
17617N/AReverse the byte order of the sample. This option only works with 16&ndash; and
17617N/A32-bit data.
17617N/A</para></listitem></varlistentry>
17617N/A</variablelist>
17617N/A
17617N/A<para>
17617N/AFor more information about these options, see
17617N/A<citerefentry> <refentrytitle>sox</refentrytitle>
17617N/A<manvolnum>1</manvolnum></citerefentry>.
10139N/A</para>
10139N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-oper"><title>&oper-tt;</title>
17617N/A<para>
17617N/AThe following operands are supported:
17617N/A</para>
17617N/A
17617N/A<variablelist termlength="medium"><varlistentry>
17617N/A<term><option role="nodash"><replaceable>infile</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecifies the name of the sound file to be played by the
17617N/A<command>&cmd;</command> command.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><option role="nodash"><replaceable>outfile</replaceable></option></term>
17617N/A<listitem><para>
17617N/ASpecifies the name of the file to which the sound recorded by the
17617N/A<command>rec</command> command should be saved.
17617N/A</para></listitem></varlistentry>
17617N/A</variablelist>
17617N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-exam"><title>&exam-tt;</title>
10139N/A<example role="example"><title>Playing a File at Half Speed</title>
17617N/A<para><screen>
17617N/Aexample% <userinput>&cmd; <replaceable>file.wav</replaceable> stretch 2</userinput>
17617N/A</screen></para>
10139N/A</example>
10139N/A<example role="example"><title>Playing a File at Double Speed</title>
17617N/A<para><screen>
17617N/Aexample% <userinput>&cmd; <replaceable>file.wav</replaceable> stretch .5</userinput>
17617N/A</screen></para>
10139N/A</example>
10139N/A<example role="example"><title>Recording a Sound</title>
17617N/A<para><screen>
17617N/Aexample% <userinput>rec <replaceable>file.wav</replaceable></userinput>
17617N/A</screen></para>
17617N/A<para>
17617N/AUse <literal>Ctrl-C</literal> to stop recording.
17617N/A</para>
17617N/A
17617N/A<para>
17617N/AFor more examples, see
17617N/A<citerefentry><refentrytitle>soxexam</refentrytitle>
17617N/A<manvolnum>5</manvolnum></citerefentry>.
17617N/A</para>
10139N/A</example>
10139N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-exit"><title>&exit-tt;</title>
17617N/A<para>
17617N/AThe following exit values are returned:
17617N/A</para>
17617N/A<variablelist termlength="xtranarrow"><varlistentry>
17617N/A<term><returnvalue>0</returnvalue></term>
17617N/A<listitem><para>
17617N/AApplication exited successfully
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><returnvalue>>0</returnvalue></term>
17617N/A<listitem><para>
17617N/AApplication exited with failure
17617N/A</para></listitem></varlistentry>
17617N/A</variablelist>
17617N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-file"><title>&file-tt;</title>
17617N/A<para>
17617N/AThe following files are used by this application:
17617N/A</para>
17617N/A<variablelist termlength="medium">
17617N/A<varlistentry>
17617N/A<term><filename>/usr/bin/&cmd;</filename></term>
17617N/A<listitem><para>
17617N/AThe command-line executable for the <command>&cmd;</command> application.
17617N/A</para></listitem></varlistentry>
17617N/A<varlistentry>
17617N/A<term><filename>/usr/bin/rec</filename></term>
17617N/A<listitem><para>
17617N/AThe command-line executable for the <command>rec</command> application.
17617N/A</para></listitem></varlistentry>
17617N/A</variablelist>
17617N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-attr"><title>&attr-tt;</title>
17617N/A<para>
17617N/ASee
17617N/A<olink targetdocent="REFMAN5" localinfo="attributes-5">
17617N/A<citerefentry><refentrytitle>attributes</refentrytitle>
17617N/A<manvolnum>5</manvolnum></citerefentry></olink>
17617N/Afor descriptions of the following attributes:
17617N/A</para>
17617N/A
10139N/A<informaltable frame="all">
17617N/A<tgroup cols="2" colsep="1" rowsep="1">
17617N/A<colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
17617N/A<row>
17617N/A<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
17617N/A<entry align="center" valign="middle">ATTRIBUTE VALUE</entry>
17617N/A</row>
10139N/A</thead>
10139N/A<tbody>
17617N/A<row>
17617N/A<entry><para>Availability</para></entry>
18745N/A<entry><para>gnome/media/sound-recorder
17617N/A</para></entry>
17617N/A</row>
17617N/A<row>
17617N/A<entry colname="COLSPEC0"><para>Interface stability</para></entry>
17617N/A<entry colname="COLSPEC1"><para>Volatile</para></entry>
17617N/A</row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
17617N/A<para>
17617N/A<citerefentry><refentrytitle>sox</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
17617N/A<citerefentry><refentrytitle>soxexam</refentrytitle><manvolnum>5</manvolnum></citerefentry></para>
10139N/A</refsect1>
17617N/A
10139N/A<refsect1 id="play-1-note"><title>&note-tt;</title>
17617N/A<para>
17617N/AWritten by Guenter Geiger (geiger@iem.mhsg.ac.at) for Debian GNU/Linux.
17617N/AUpdated by Ghee Teo, Sun Microsystems Inc., 2003.
17617N/A</para>
10139N/A</refsect1>
10139N/A</refentry>