Out1bUG Class Reference

Out1bUG simply writes its input patchpoint to the right channel. More...

#import <Out1bUG.h>

Inheritance diagram for Out1bUG:

MKUnitGenerator

List of all members.

Public Member Functions

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

Static Public Member Functions

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


Detailed Description

Out1bUG simply writes its input patchpoint to the right channel.

Out1aUG, Out1bUG and Out1nUG provide single-channel access to the DSP's stereo output stream. Out1aUG writes its input signal to the left channel, Out1bUG writes to the right channel and Out1nUG allows the channel to be set with a method. To write a stereo signal, it may be more convenient to use a single Out2sumUG object rather than one of each of these.

Where the samples that are written to the DSP output stream are ultimately sent

If you're building a MKSynthPatch subclass, you should note that every MKSynthPatch object should have its own signal-output MKUnitGenerator; in other words, you don't allocate just one such object and then share it amongst the various MKSynthPatches. The output signals produced by all the running Out1aUG's, Out1bUG's, Out1nUG's and Out2sumUG's are mixed (added) together into the DSP's output stream.

Out1nUG additionally makes possible quadraphonic (or other multi-channel) output, with the proper external serial port device. Additionally, the orchestra must be set up as follows:

[anOrch setSerialSoundOut:YES]; [anOrch setSerialPortDevice:[[QuadSerialPortDevice alloc] init]]; [anOrch open];

where QuadSerialPortDevice is a custom subclass of DSPSerialPortDevice that overrides the -outputChannelCount method to return 4 and overrides the -setUpSerialPort: method to send the correct settings for the particular device.

Memory Spaces

Out1bUGa a input


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 input signal is scaled for the right channel.

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) setInput: (id)  aPatchPoint  

Sets the input 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:16 2009 for MusicKit by  doxygen 1.5.6