MusicKit  0.0.0
Public Member Functions
EnvFollowUG Class Reference

EnvFollowUG derives an amplitude envelope from an input signal. More...

#import <EnvFollowUG.h>

Inheritance diagram for EnvFollowUG:
MKUnitGenerator

List of all members.

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.

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:
aPatchPointis 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:
aPatchPointis 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:
valueis a double.
Returns:
Returns an id.

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