AEPeakLimiterModule Class Reference

#import <AEPeakLimiterModule.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 attackTime
 range is from 0.001 to 0.03 seconds. Default is 0.012 seconds.
 
double decayTime
 range is from 0.001 to 0.06 seconds. Default is 0.024 seconds.
 
double preGain
 range is from -40dB to 40dB. Default is 0dB.
 
- 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) attackTime
readwritenonatomicassign

range is from 0.001 to 0.03 seconds. Default is 0.012 seconds.

- (double) decayTime
readwritenonatomicassign

range is from 0.001 to 0.06 seconds. Default is 0.024 seconds.

- (double) preGain
readwritenonatomicassign

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


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