MusicKit  0.0.0
Public Member Functions
In1qpUG Class Reference

In1qpUG is useful when using the Ariel QuintProcessor - it provides the "hub" DSP with the signals from the "satellite" DSPs. More...

#import <In1qpUG.h>

Inheritance diagram for In1qpUG:
MKUnitGenerator

List of all members.

Public Member Functions

(id) - setChannel:
 Sets the input channel that this instance of In1qpUG reads.
(id) - setScale:
 Sets the scale as specified.
(id) - setSatellite:
 Sets the DSP from which this instance of In1qpUG reads its input sample stream.
(id) - setOutput:
 Sets the output patchpoint to aPatchPoint.
(id) - idleSelf
 You never send this message.
(id) - runSelf
 If scale has not been set, sets it to 1.0.

Detailed Description

In1qpUG is useful when using the Ariel QuintProcessor - it provides the "hub" DSP with the signals from the "satellite" DSPs.

The In1qpUG may only be used on the hub (master DSP) of theAriel QuintProcessor, which is represented by an instance of the ArielQP object. In1qpUG reads one channel of the sample stream coming from one of the QuintProcessor satellite DSPs.

If you're building a SynthPatch subclass, you should note that every SynthPatch object should have its own signal-input UnitGenerator; in other words, you don't allocate just one such object and then share it amongst the various SynthPatches. The input signal is sent to all the In1qpUGs for a given channel and satellite DSP setting.

Memory Spaces

In1qpUGa a output


Member Function Documentation

- (id) idleSelf

You never send this message.

Returns:
Returns an id. It's invoked by sending the idle message to the object. In1qpUG idles itself by patching its output to zero. Thus, an idle In1aUG makes no sound. Note that you must send setOutput: and run again to use the MKUnitGenerator after sending idle.
- (id) runSelf

If scale has not been set, sets it to 1.0.

Returns:
Returns an id. If Satellite has not been set, it is set to 'A'. This method is invoked when you send the run message to the object.
- (id) setChannel: (int)  aChan

Sets the input channel that this instance of In1qpUG reads.

Channel 0 is the first channel, channel 1 is the second channel. For quadraphonic streams, aChan may be larger.

Parameters:
aChanis an integer, 0-based channel.
Returns:
Returns an id.
- (id) setOutput: (id)  aPatchPoint

Sets the output patchpoint to aPatchPoint.

Parameters:
aPatchPointis an id.
Returns:
Returns an id. Returns nil if the argument isn't a patchpoint; otherwise returns self.
- (id) setSatellite: (char)  sat

Sets the DSP from which this instance of In1qpUG reads its input sample stream.

Parameters:
satis a char.
Returns:
Returns an id. sat is the DSP, one of 'A', 'B', 'C' or 'D'.
- (id) setScale: (double)  value

Sets the scale as specified.

The default is 1.0.

Parameters:
valueis a double.
Returns:
Returns an id.

The documentation for this class was generated from the following file: