summaryrefslogtreecommitdiff
path: root/opcodes/chnmix.xml
blob: 3b55f8974857c3e5877f1f4c52b3b9aa64d30365 (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
<refentry id="chnmix">
<indexterm id="Indexchnmix"><primary>chnmix</primary></indexterm>
  <refentryinfo><title>Signal I/O:Software Bus</title></refentryinfo>
  <refmeta>
    <refentrytitle>chnmix</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>chnmix</refname>
    <refpurpose>
      Writes audio data to the named software bus, mixing to the previous
      output.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Adds an audio signal to a channel of the named software bus.
      Implies declaring the channel with <emphasis>imode</emphasis>=2 (see also
      <link linkend="chn"><citetitle>chn_a</citetitle></link>).
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>chnmix</command> aval, Sname</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>Sname</emphasis> -- a string that indicates which
      named channel of the software bus to write.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>aval</emphasis> -- the audio signal to write at performance
      time.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the chnmix opcode. It uses the file <ulink url="examples/chnmix.csd"><citetitle>chnmix.csd</citetitle></ulink>.
      <example>
        <title>Example of the chnmix opcode.</title>
        <xi:include href="examples-xml/chnmix.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &nameistvan;</member>
        <member>2006</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>