AEDynamicsProcessorModule Class Reference

#import <AEDynamicsProcessorModule.h>

Inherits AEAudioUnitModule.

Instance Methods

(instancetype _Nullable) - initWithRenderer:
 Initializer.
 
- Instance Methods inherited from AEAudioUnitModule
(instancetype _Nullable) - initWithRenderer:componentDescription:
 Default initializer.
 
(instancetype _Nullable) - initWithRenderer:componentDescription:subrenderer:
 Sub-renderer initializer.
 
(double) - getParameterValueForId:
 Get an audio unit parameter.
 
(void) - setParameterValue:forId:
 Set an audio unit parameter.
 
(BOOL) - setup
 Setup audio unit.
 
(void) - initialize
 Initialize audio unit.
 
(void) - teardown
 Cleanup audio unit.
 
(AudioUnit _Nonnull) - AEAudioUnitModuleGetAudioUnit
 Get access to audio unit.
 
- Instance Methods inherited from AEModule
(instancetype _Nonnull) - NS_UNAVAILABLE
 
(void) - rendererDidChangeSampleRate
 Notifies the module that the renderer's sample rate has changed.
 
(void) - rendererDidChangeNumberOfChannels
 Notifies the module that the renderer's channel count has changed.
 

Properties

double threshold
 range is from -40dB to 20dB. Default is -20dB.
 
double headRoom
 range is from 0.1dB to 40dB. Default is 5dB.
 
double expansionRatio
 range is from 1 to 50 (rate). Default is 2.
 
double expansionThreshold
 
double attackTime
 range is from 0.0001 to 0.2. Default is 0.001.
 
double releaseTime
 range is from 0.01 to 3. Default is 0.05.
 
double masterGain
 range is from -40dB to 40dB. Default is 0dB.
 
double compressionAmount
 
double inputAmplitude
 
double outputAmplitude
 
- Properties inherited from AEAudioUnitModule
AudioComponentDescription componentDescription
 The component description.
 
AudioUnit _Nonnull audioUnit
 The audio unit.
 
BOOL hasInput
 Whether the audio unit processes input (and thus will process buffers in place, rather than pushing new buffers)
 
double wetDry
 Wet/dry amount, for use with effect audio unit types. 0.0-1.0; 0.0 bypasses the effect entirely.
 
AERenderer *_Nullable subrenderer
 Sub-renderer, for use with format converter audio unit types, such as the varispeed and time/pitch units.
 
- Properties inherited from AEModule
AEModuleProcessFunc _Nonnull processFunction
 Process function.
 
AEModuleIsActiveFunc _Nullable isActiveFunction
 Active test function.
 
AERenderer *_Nullable renderer
 The renderer.
 

Method Documentation

- (instancetype _Nullable) initWithRenderer: (AERenderer *_Nullable)  NS_DESIGNATED_INITIALIZER

Initializer.

Parameters
rendererThe renderer.

Implements AEModule.

Property Documentation

- (double) threshold
readwritenonatomicassign

range is from -40dB to 20dB. Default is -20dB.

- (double) headRoom
readwritenonatomicassign

range is from 0.1dB to 40dB. Default is 5dB.

- (double) expansionRatio
readwritenonatomicassign

range is from 1 to 50 (rate). Default is 2.

- (double) expansionThreshold
readwritenonatomicassign
- (double) attackTime
readwritenonatomicassign

range is from 0.0001 to 0.2. Default is 0.001.

- (double) releaseTime
readwritenonatomicassign

range is from 0.01 to 3. Default is 0.05.

- (double) masterGain
readwritenonatomicassign

range is from -40dB to 40dB. Default is 0dB.

- (double) compressionAmount
readnonatomicassign
- (double) inputAmplitude
readnonatomicassign
- (double) outputAmplitude
readnonatomicassign

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