AEExpanderFilter Class Reference

An expander/noise gate filter. More...

#import <AEExpanderFilter.h>

Inherits <NSObject>, and <AEAudioFilter>.

Instance Methods

(id) - init
 Initialise.
 
(void) - assignPreset:
 Apply a preset.
 
(void) - startCalibratingWithCompletionBlock:
 Calibrate the threshold.
 
- Instance Methods inherited from <AEAudioFilter>
(void) - setupWithAudioController:
 Perform setup, to prepare for playback.
 
(void) - teardown
 Clean up resources.
 

Properties

float ratio
 
double threshold
 
double hysteresis
 
NSTimeInterval attack
 
NSTimeInterval decay
 
- Properties inherited from <AEAudioFilter>
AEAudioFilterCallback filterCallback
 Reference to the filter callback.
 

Detailed Description

An expander/noise gate filter.

This class implements an expander filter, which reduces audio levels beneath a set threshold in order to hide background noise.

Method Documentation

- (id) init

Initialise.

- (void) assignPreset: (AEExpanderFilterPreset preset

Apply a preset.

- (void) startCalibratingWithCompletionBlock: (void)  block

Calibrate the threshold.

This method enters calibration mode, watching the input level and setting the threshold to the maximum level seen. The user should be silent during this period, to get an accurate measure of the noise floor.

Parameters
blockBlock to perform when calibration is complete

Property Documentation

- (float) ratio
readwritenonatomicassign
- (double) threshold
readwritenonatomicassign
- (double) hysteresis
readwritenonatomicassign
- (NSTimeInterval) attack
readwritenonatomicassign
- (NSTimeInterval) decay
readwritenonatomicassign

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