summaryrefslogtreecommitdiff
path: root/opcodes/outletk.xml
blob: bb387f09ddcfb6ea964b253e661f5f93afb1d065 (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
<refentry id="outletk">
<indexterm id="Indexoutletk"><primary>outletk</primary></indexterm>
  <refentryinfo><title>Signal Flow Graph Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>outletk</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>outletk</refname>
    <refpurpose>
      Sends a krate signal out from an instrument to a named port.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Sends a krate signal out from an instrument to a named port. 
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>outletk </command>Sname, ksignal</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>Sname</emphasis> -- String name of the outlet port.       
      The name of the outlet is implicitly qualified by the instrument name 
      or number, so it is valid to use the same outlet name in more than one 
      instrument (but not to use the same outlet name twice in one instrument).
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ksignal</emphasis> -- krate output signal
    </para>

    <para>
      During performance, the krate output signal is sent to each instance of an instrument
      containing an inlet port to which this outlet has been connected using the <link linkend="connect">connect</link> opcode.
      The signals of all the outlets connected to an inlet are summed in the inlet.
    </para>
  </refsect1>

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="outleta"><citetitle>outleta</citetitle></link>
      <link linkend="outletf"><citetitle>outletf</citetitle></link>
      <link linkend="outletkid"><citetitle>outletkid</citetitle></link>
      <link linkend="inleta"><citetitle>inleta</citetitle></link>
      <link linkend="inletk"><citetitle>inletk</citetitle></link>
      <link linkend="inletkid"><citetitle>inletkid</citetitle></link>
      <link linkend="inletf"><citetitle>inletf</citetitle></link>
      <link linkend="connect"><citetitle>connect</citetitle></link>
      <link linkend="alwayson"><citetitle>alwayson</citetitle></link>
      <link linkend="ftgenonce"><citetitle>ftgenonce</citetitle></link>
    </para>
            <para> More information on this opcode: <ulink url="http://www.csounds.com/journal/issue13/signalFlowGraphOpcodes.html"><citetitle>http://www.csounds.com/journal/issue13/signalFlowGraphOpcodes.html</citetitle></ulink>  , written by Michael Gogins </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>By: &namemichael; 2009</para>
  </refsect1>
</refentry>