summaryrefslogtreecommitdiff
path: root/modules/sound/help/en_US/wavwrite.xml
blob: 0cac7fa7062cdd945e9c75f202a5b239878d79c4 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?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:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="wavwrite" xml:lang="en">
    <refnamediv>
        <refname>wavwrite</refname>
        <refpurpose>writes .wav sound file</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>wavwrite(y, wavfile)
            wavwrite(y, Fs, wavfile)
            wavwrite(y, Fs, nbits, wavfile)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>real vector or matrix with entries in [-1,1].</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>wavfile</term>
                <listitem>
                    <para>string (The .wav extension is appended if no extension is
                        given)
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>Fs</term>
                <listitem>
                    <para>integer, frequency sampling in Hz. 22500 is the default value.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>nbits</term>
                <listitem>
                    <para>bit-depth 8, 16, 24, 32 bits. it describes the number of bits of information recorded for each sample.
                        16 is the default value.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Utility function to save <literal>.wav</literal> sound file.
            <literal>wavwrite(y,wavfile)</literal> writes a sound file specified by
            the string wavfile. The data should be arranged with one channel per
            column. Amplitude values outside the range [-1,+1] are ignored.
        </para>
        <para>
            <literal>wavwrite(y,Fs,wavfile)</literal> specifies in
            <literal>Fs</literal> the sample rate of the data in Hertz.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
A=matrix(1:6,2,3);
wavwrite(A/6,TMPDIR+'/foo.wav');
B=wavread(TMPDIR+'/foo.wav');
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="auread">auread</link>
            </member>
            <member>
                <link linkend="wavread">wavread</link>
            </member>
            <member>
                <link linkend="savewave">savewave</link>
            </member>
            <member>
                <link linkend="analyze">analyze</link>
            </member>
            <member>
                <link linkend="mapsound">mapsound</link>
            </member>
        </simplelist>
    </refsection>
</refentry>