summaryrefslogtreecommitdiff
path: root/opcodes/nchnls_i.xml
blob: 6303914fa116232f81a07ad551ad42b4bfab2f5e (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
<refentry id="nchnls_i">
<indexterm id="IndexNchns_I"><primary>nchnls_i</primary></indexterm>
  <refentryinfo><title>Orchestra Syntax:Header</title></refentryinfo>
  <refmeta>
    <refentrytitle>nchnls_i</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>nchnls_i</refname>

    <refpurpose>
      Sets the number of channels of audio input.
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para> 
      These statements are global value <link
      linkend="assign"><citetitle>assignments</citetitle></link>, made
      at the beginning of an orchestra, before any instrument block is
      defined. Their function is to set certain <link
      linkend="VariableTypes"><citetitle>reserved symbol
      variables</citetitle></link> that are required for
      performance. Once set, these reserved symbols can be used in
      expressions anywhere in the orchestra.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>nchnls_i</command> = iarg</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
<emphasis>nchnls_i</emphasis> = (optional) -- set number of channels of
audio input to <emphasis>iarg</emphasis>. (1 = mono, 2 = stereo, 4 =
quadraphonic.) The default value is the valus of <emphasis>nchnls</emphasis>.
    </para>

    <para>
      In addition, any <link linkend="GlobalVariables"><citetitle>global variable</citetitle></link> can be initialized by an <emphasis>init-time assignment</emphasis> anywhere before the first <link linkend="instr"><citetitle>instr statement</citetitle></link>.  All of the above assignments are run as instrument 0 (i-pass only) at the start of real performance.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the nchnls_i opcode. It uses the file <ulink url="examples/nchnls_i.csd"><citetitle>nchnls_i.csd</citetitle></ulink>.
      <example>
        <title>Example of the nchnls_i opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/nchnls_i.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
  
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="kr"><citetitle>kr</citetitle></link>,
      <link linkend="ksmps"><citetitle>ksmps</citetitle></link>,
      <link linkend="nchnls"><citetitle>nchnls</citetitle></link>,
      <link linkend="sr"><citetitle>sr</citetitle></link>
    </para>
  </refsect1>
</refentry>