summaryrefslogtreecommitdiff
path: root/modules/sound/help/en_US/playsnd.xml
blob: 7c158eea6115ec2e7a5270e6da0227ba0c2accf7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) ????-2006 - INRIA - Scilab
    *
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at
    * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
    *
    -->
<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">
    <refnamediv>
        <refname>playsnd</refname>
        <refpurpose>sound player facility</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>[]=playsnd(y)
            []=playsnd(y,rate,bits [,command])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>A matrix. Each line describes a channel</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>fs</term>
                <listitem>
                    <para>real number, sampling frequency (default value is 22050).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>bits</term>
                <listitem>
                    <para>real number, number of bits (usually 8 or 16). Unused yet.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>command</term>
                <listitem>
                    <para>Only used on Unix systems it gives the name of the command to use for playing sound
                        (wav) files. The default value is <literal>play</literal>. If set <literal>/dev/audio</literal> then
                        a 8 bits mu-law raw sound file is created and send to <literal>/dev/audio</literal>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Plays a multi channel signal given by a Scilab matrix were sound is sampled at rate given by
            <literal>rate</literal>.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// a two channel signal
y=loadwave("SCI/modules/sound/demos/chimes.wav");
playsnd(y)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="lin2mu">lin2mu</link>
            </member>
            <member>
                <link linkend="wavread">wavread</link>
            </member>
        </simplelist>
    </refsection>
</refentry>