blob: 6e1cd8da6c332bcc10d09c6efa79d82d81737b3f (
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
|
<refentry id="inletkid">
<indexterm id="Indexinletkid"><primary>inletkid</primary></indexterm>
<refentryinfo><title>Signal Flow Graph Opcodes</title></refentryinfo>
<refmeta>
<refentrytitle>inletkid</refentrytitle>
</refmeta>
<refnamediv>
<refname>inletkid</refname>
<refpurpose>
Receives a krate signal into an instrument from a named port.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Receives a krate signal into an instrument from a named port.
</para>
</refsect1>
<refsect1>
<title>Syntax</title>
<synopsis>ksignal <command>inletkid </command>Sname, SinstanceID</synopsis>
</refsect1>
<refsect1>
<title>Initialization</title>
<para>
<emphasis>Sname</emphasis> -- String name of the inlet port.
The name of the inlet is implicitly qualified by the instrument name
or number, so it is valid to use the same inlet name in more than one
instrument (but not to use the same inlet name twice in one instrument).
</para>
<para>
<emphasis>SinstanceID</emphasis> -- String name of the outlet port's
instance ID. This enables the inlet to discriminate between different
instances of the outlet, e,g. one instance of the outlet might be created by a note
specifying one instance ID, and another instance might be created by a note
specifying another ID. This might be used, e.g., to situate difference instances
of an instrument at different points in an Ambisonic space in a spatializing
effects processor.
</para>
</refsect1>
<refsect1>
<title>Performance</title>
<para>
<emphasis>ksignal</emphasis> -- krate input signal
</para>
<para>
During performance, the krate inlet signal is received from each instance of an instrument
containing an outlet port to which this inlet has been connected using the
<link linkend="connect">connect</link> opcode. The signals of all the outlets that
are connected to an inlet, but only those share the specified instance ID, are summed in the inlet.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<link linkend="outleta"><citetitle>outleta</citetitle></link>
<link linkend="outletk"><citetitle>outletk</citetitle></link>
<link linkend="outletkid"><citetitle>outletkid</citetitle></link>
<link linkend="outletf"><citetitle>outletf</citetitle></link>
<link linkend="inleta"><citetitle>inleta</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>
</refsect1>
<refsect1>
<title>Credits</title>
<para>By: &namemichael; 2009</para>
</refsect1>
</refentry>
|
