EnvFollowUG Class Reference
EnvFollowUG derives an amplitude envelope from an input signal. More...
#import <EnvFollowUG.h>
Public Member Functions | |
| (id) | - setInput: |
| Sets the input patchpoint to aPatchPoint. | |
| (id) | - setOutput: |
| Sets the output patchpoint to aPatchPoint. | |
| (id) | - setRelease: |
| Release determines how quickly the object responds to amplitude changes. | |
| (id) | - init |
| Invoke this method when the receiver is is created, after its code is loaded. | |
| (id) | - idleSelf |
| A subclass may override this method to provide instructions for idling. | |
| (id) | - runSelf |
| Subclass implementation of this method provides instructions for making the object's DSP code usable (as defined by the subclass). | |
Detailed Description
EnvFollowUG derives an amplitude envelope from an input signal.EnvFollowUG is an envelope follower, that tracks the peaks of a signal. It converts an arbitrary signal to an envelope-like signal that is always positive and changes relatively slowly.
Memory Spaces
DelayUGab a output b input
Member Function Documentation
| - (id) setInput: | (id) | aPatchPoint |
Sets the input patchpoint to aPatchPoint.
- Parameters:
-
aPatchPoint is an id.
- Returns:
- Returns nil if the argument isn't a patchpoint; otherwise returns self.
| - (id) setOutput: | (id) | aPatchPoint |
Sets the output patchpoint to aPatchPoint.
- Parameters:
-
aPatchPoint is an id.
- Returns:
- Returns nil if the argument isn't a patchpoint; otherwise returns self.
| - (id) setRelease: | (double) | value |
Release determines how quickly the object responds to amplitude changes.
More precisely, it is the coefficient of the one-pole filter that implements the envelope decay. Typical values are between 0.9 and 0.99.
- Parameters:
-
value is a double.
- Returns:
- Returns an id.
| - (id) init |
Invoke this method when the receiver is is created, after its code is loaded.
If this method returns nil, the receiver is automatically freed by the MKOrchestra. A subclass implementation should send [super init] before doing its own initialization and should immediately return nil if [super init] returns nil. The default implementation returns self.
- Returns:
- Returns an id.
Reimplemented from MKUnitGenerator.
| - (id) idleSelf |
A subclass may override this method to provide instructions for idling.
The default does nothing and returns the receiver. Most MKUnitGenerator subclasses implement idleSelf to patch their outputs to sink, a location that, by convention, nobody reads. MKUnitGenerators that have inputs, such as Out2sumUG, implement idleSelf to patch their inputs to zero, a location that always holds the value 0.0.
- Returns:
- Returns an id.
Reimplemented from MKUnitGenerator.
| - (id) runSelf |
Subclass implementation of this method provides instructions for making the object's DSP code usable (as defined by the subclass).
You never invoke this method directly, it's invoked automatically by the run method. The default does nothing and returns the receiver.
- Returns:
- Returns an id.
Reimplemented from MKUnitGenerator.
The documentation for this class was generated from the following file:
