Typo fixes
[scilab.git] / scilab / modules / sound / help / en_US / playsnd.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) ????-2006 - INRIA - Scilab
5     *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14     *
15     -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="playsnd">
17     <refnamediv>
18         <refname>playsnd</refname>
19         <refpurpose>sound player facility</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[]=playsnd(y)
24             []=playsnd(y,rate,bits [,command])
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>y</term>
32                 <listitem>
33                     <para>A matrix. Each line describes a channel</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>rate</term>
38                 <listitem>
39                     <para>real number, sampling frequency (default value is 22050).</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>bits</term>
44                 <listitem>
45                     <para>real number, number of bits (usually 8 or 16). Unused yet.</para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>command</term>
50                 <listitem>
51                     <para>Only used on Unix systems it gives the name of the command to use for playing sound
52                         (wav) files. The default value is <literal>play</literal>. If set <literal>/dev/audio</literal> then
53                         a 8 bits mu-law raw sound file is created and send to <literal>/dev/audio</literal>
54                     </para>
55                 </listitem>
56             </varlistentry>
57         </variablelist>
58     </refsection>
59     <refsection>
60         <title>Description</title>
61         <para>Plays a multi channel signal given by a Scilab matrix were sound is sampled at rate given by
62             <literal>rate</literal>.
63         </para>
64     </refsection>
65     <refsection>
66         <title>Examples</title>
67         <programlisting role="example"><![CDATA[
68 // A two channel signal
69 y = loadwave("SCI/modules/sound/demos/chimes.wav");
70 playsnd(y)
71  ]]></programlisting>
72     </refsection>
73     <refsection role="see also">
74         <title>See Also</title>
75         <simplelist type="inline">
76             <member>
77                 <link linkend="lin2mu">lin2mu</link>
78             </member>
79             <member>
80                 <link linkend="wavread">wavread</link>
81             </member>
82         </simplelist>
83     </refsection>
84 </refentry>