inletkid

inletkid — Receives a krate signal into an instrument from a named port.

Description

Plugin opcode in signalflowgraph

Receives a krate signal into an instrument from a named port.

Syntax

ksignal inletkid Sname, SinstanceID

Initialization

Sname -- 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).

SinstanceID -- 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.

Performance

ksignal -- krate input signal

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 connect 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.

See Also

outleta outletk outletkid outletf inleta inletf connect alwayson ftgenonce

Credits

By: Michael Gogins 2009