AEDistortionModule Class Reference

#import <AEDistortionModule.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	delay
	range is from 0.1 to 500 milliseconds. Default is 0.1.
double	decay
	range is from 0.1 to 50 (rate). Default is 1.0.
double	delayMix
	range is from 0 to 100 (percentage). Default is 50.
double	decimation
	range is from 0% to 100%.
double	rounding
	range is from 0% to 100%. Default is 0%.
double	decimationMix
	range is from 0% to 100%. Default is 50%.
double	linearTerm
	range is from 0 to 1 (linear gain). Default is 1.
double	squaredTerm
	range is from 0 to 20 (linear gain). Default is 0.
double	cubicTerm
	range is from 0 to 20 (linear gain). Default is 0.
double	polynomialMix
	range is from 0% to 100%. Default is 50%.
double	ringModFreq1
	range is from 0.5Hz to 8000Hz. Default is 100Hz.
double	ringModFreq2
	range is from 0.5Hz to 8000Hz. Default is 100Hz.
double	ringModBalance
	range is from 0% to 100%. Default is 50%.
double	ringModMix
	range is from 0% to 100%. Default is 0%.
double	softClipGain
	range is from -80dB to 20dB. Default is -6dB.
double	finalMix
	range is from 0% to 100%. Default is 50%.
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

renderer

The renderer.

Implements AEModule.

Property Documentation

- (double) delay

readwritenonatomicassign

range is from 0.1 to 500 milliseconds. Default is 0.1.

- (double) decay

readwritenonatomicassign

range is from 0.1 to 50 (rate). Default is 1.0.

- (double) delayMix

readwritenonatomicassign

range is from 0 to 100 (percentage). Default is 50.

- (double) decimation

readwritenonatomicassign

range is from 0% to 100%.

- (double) rounding

readwritenonatomicassign

range is from 0% to 100%. Default is 0%.

- (double) decimationMix

readwritenonatomicassign

range is from 0% to 100%. Default is 50%.

- (double) linearTerm

readwritenonatomicassign

range is from 0 to 1 (linear gain). Default is 1.

- (double) squaredTerm

readwritenonatomicassign

range is from 0 to 20 (linear gain). Default is 0.

- (double) cubicTerm

readwritenonatomicassign

range is from 0 to 20 (linear gain). Default is 0.

- (double) polynomialMix

readwritenonatomicassign

range is from 0% to 100%. Default is 50%.

- (double) ringModFreq1

readwritenonatomicassign

range is from 0.5Hz to 8000Hz. Default is 100Hz.

- (double) ringModFreq2

readwritenonatomicassign

range is from 0.5Hz to 8000Hz. Default is 100Hz.

- (double) ringModBalance

readwritenonatomicassign

range is from 0% to 100%. Default is 50%.

- (double) ringModMix

readwritenonatomicassign

range is from 0% to 100%. Default is 0%.

- (double) softClipGain

readwritenonatomicassign

range is from -80dB to 20dB. Default is -6dB.

- (double) finalMix

readwritenonatomicassign

range is from 0% to 100%. Default is 50%.

---

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

• AEDistortionModule.h