← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/sound/help/en_US/savewave.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/sound/help/en_US/savewave.xml
11
11
    *
12
12
    -->
13
13
<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" version="5.0-subset Scilab" xml:id="savewave" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>savewave</refname>
16
 
    <refpurpose>save data into a sound wav file.</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>savewave(filename,x [, rate , nbits]);</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>filename</term>
27
 
        <listitem>
28
 
          <para>a string. The path of the output wav file</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>x</term>
33
 
        <listitem>
34
 
          <para>a mxn matrix where m is the number of channels and n the
35
 
            number of samples for each channel
36
 
          </para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>rate</term>
41
 
        <listitem>
42
 
          <para>a scalar giving the sampling rate (number of sample per
43
 
            second) 22050 is the default value.
44
 
          </para>
45
 
        </listitem>
46
 
      </varlistentry>
47
 
    </variablelist>
48
 
  </refsection>
49
 
  <refsection>
50
 
    <title>Description</title>
51
 
    <para>save x into a wav sound file. you can transform other sound files
52
 
      into wav file with the <literal>sox</literal> program.
53
 
    </para>
54
 
  </refsection>
55
 
  <refsection>
56
 
    <title>Examples</title>
57
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>savewave</refname>
 
16
        <refpurpose>save data into a sound wav file.</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>savewave(filename,x [, rate , nbits]);</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>filename</term>
 
27
                <listitem>
 
28
                    <para>a string. The path of the output wav file</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>x</term>
 
33
                <listitem>
 
34
                    <para>a mxn matrix where m is the number of channels and n the
 
35
                        number of samples for each channel
 
36
                    </para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>rate</term>
 
41
                <listitem>
 
42
                    <para>a scalar giving the sampling rate (number of sample per
 
43
                        second) 22050 is the default value.
 
44
                    </para>
 
45
                </listitem>
 
46
            </varlistentry>
 
47
        </variablelist>
 
48
    </refsection>
 
49
    <refsection>
 
50
        <title>Description</title>
 
51
        <para>save x into a wav sound file. you can transform other sound files
 
52
            into wav file with the <literal>sox</literal> program.
 
53
        </para>
 
54
    </refsection>
 
55
    <refsection>
 
56
        <title>Examples</title>
 
57
        <programlisting role="example"><![CDATA[ 
58
58
// At first we create 0.5 seconds of sound parameters.
59
59
t=soundsec(0.5);
60
60
 
64
64
s(nc/2:nc)=sin(2*%pi*330*t(nc/2:nc));
65
65
savewave(TMPDIR+'/foo.wav',s);
66
66
 ]]></programlisting>
67
 
  </refsection>
68
 
  <refsection role="see also">
69
 
    <title>See Also</title>
70
 
    <simplelist type="inline">
71
 
      <member>
72
 
        <link linkend="loadwave">loadwave</link>
73
 
      </member>
74
 
      <member>
75
 
        <link linkend="analyze">analyze</link>
76
 
      </member>
77
 
      <member>
78
 
        <link linkend="mapsound">mapsound</link>
79
 
      </member>
80
 
    </simplelist>
81
 
  </refsection>
 
67
    </refsection>
 
68
    <refsection role="see also">
 
69
        <title>See Also</title>
 
70
        <simplelist type="inline">
 
71
            <member>
 
72
                <link linkend="loadwave">loadwave</link>
 
73
            </member>
 
74
            <member>
 
75
                <link linkend="analyze">analyze</link>
 
76
            </member>
 
77
            <member>
 
78
                <link linkend="mapsound">mapsound</link>
 
79
            </member>
 
80
        </simplelist>
 
81
    </refsection>
82
82
</refentry>