In1aUG Class Reference

In1aUG reads sound from the left channel of DSP serial port and writes it to its output patchpoint. More...

#import <In1aUG.h>

Inheritance diagram for In1aUG:

MKUnitGenerator

List of all members.

Public Member Functions

(id) - setScale:
 Sets the factor by which the output signal is scaled.
(id) - runSelf
 If scale has not been set, sets it to 1.0.
(id) - setOutput:
 Sets the output patchpoint to aPatchPoint.

Static Public Member Functions

(BOOL) + shouldOptimize:
 Specifies that all arguments are to be optimized if possible.


Detailed Description

In1aUG reads sound from the left channel of DSP serial port and writes it to its output patchpoint.

In1aUG and In1bUG provide single-channel access to the DSP's stereo input stream, which comes from the DSP serial port; the former reads its input signal from the left channel, and the latter reads from the right.

In order to use an In1aUG or In1bUG, you must first send the message setSerialSoundIn:YES to the Orchestra. This must be done before the Orchestra is sent the open message.

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 In1aUGs and In1bUGs.

Memory Spaces

In1aUGa In1bUGa a output


Member Function Documentation

+ (BOOL) shouldOptimize: (unsigned)  arg  

Specifies that all arguments are to be optimized if possible.

Parameters:
arg is an unsigned.
Returns:
Returns an BOOL.

Reimplemented from MKUnitGenerator.

- (id) setScale: (double)  value  

Sets the factor by which the output signal is scaled.

By default, the scaler is set to 1.0. Effective values are between 0.0 and 1.0 (negative values are the same as their absolute values, but with a 180 degree phase shift).

Parameters:
value is a double.
Returns:
Returns self.

- (id) runSelf  

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

Returns:
Returns an id. This method is invoked when you send the run message to the object.

Reimplemented from MKUnitGenerator.

- (id) setOutput: (id)  aPatchPoint  

Sets the output patchpoint to aPatchPoint.

Parameters:
aPatchPoint is an id.
Returns:
Returns an id. Returns nil if the argument isn't a patchpoint; otherwise returns self.


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

Generated on Sat Dec 5 17:01:14 2009 for MusicKit by  doxygen 1.5.6