opcodes/ins.xml


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

<refentry id="ins">
<indexterm id="Indexins"><primary>ins</primary></indexterm>
  <refentryinfo><title>Signal I/O:Signal Input</title></refentryinfo>
  <refmeta>
    <refentrytitle>ins</refentrytitle>
  </refmeta>


  <refnamediv>
    <refname>ins</refname>
    <refpurpose>
      Reads stereo audio data from an external device or stream.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Reads stereo audio data from an external device or stream.
    </para>
    <warning>
      <title>Warning</title>
      <para>
        This opcode is designed to be used only with orchestras that have
        nchnls_i=2. Doing so with orchestras with nchnls_i &gt; 2 will
        cause incorrect audio input.
      </para>
    </warning>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ar1, ar2 <command>ins</command></synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      Reads stereo audio data from an external device or stream. If the command-line <link linkend="FlagsMinusLowerI"><citetitle>-i</citetitle></link> flag is set, sound is read continuously from the audio input stream (e.g. <emphasis>stdin</emphasis> or a soundfile) into an internal buffer. Any number of these opcodes can read freely from this buffer.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the ins opcode. It uses the file <ulink url="examples/ins.csd"><citetitle>ins.csd</citetitle></ulink>.
      <example>
        <title>Example of the ins opcode.</title>
        <xi:include href="examples-xml/ins.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>      
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="diskin"><citetitle>diskin</citetitle></link>,
      <link linkend="in"><citetitle>in</citetitle></link>,
      <link linkend="inch"><citetitle>inh</citetitle></link>,
      <link linkend="inh"><citetitle>inh</citetitle></link>,
      <link linkend="ino"><citetitle>ino</citetitle></link>,
      <link linkend="inq"><citetitle>inq</citetitle></link>,
      <link linkend="soundin"><citetitle>soundin</citetitle></link>
      <link linkend="mp3in"><citetitle>mp3in</citetitle></link>,
     </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Authors: &namebarry;, &namematt;/&namemike;</member>
        <member>MIT, Mills College</member>
        <member>1993-1997</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>