<AEAudioFilter> Protocol Referenceabstract

AEAudioFilter protocol. More...

#import <AEAudioController.h>

Inherits <NSObject>.

Inherited by AEAudioUnitFilter, AEBlockFilter, AEExpanderFilter, and AELimiterFilter.

Instance Methods

(void) - setupWithAudioController:
 Perform setup, to prepare for playback.
 
(void) - teardown
 Clean up resources.
 

Properties

AEAudioFilterCallback filterCallback
 Reference to the filter callback.
 

Detailed Description

AEAudioFilter protocol.

The interface that a filter must implement - this includes 'filterCallback', which is a C callback to be called when audio is to be filtered. The callback will be passed a reference to this object, so you should implement it from within the @implementation block to gain access to your instance variables.

Note that it is your responsibility to make sure you are using the correct AudioStreamBasicDescription for the source you are filtering.

Method Documentation

- (void) setupWithAudioController: (AEAudioController *)  audioController
optional

Perform setup, to prepare for playback.

Filter objects may implement this method to be notified when the object is being added to the audio controller, or when the audio system is being restored after a system error.

Use this method to allocate/initialise any required resources.

- (void) teardown
optional

Clean up resources.

Filter objects may implement this method to be notified when the object is being removed from the audio controller, or when the audio system is being cleaned up after a system error.

Use this method to free up any resources used.

Property Documentation

- (AEAudioFilterCallback) filterCallback
readnonatomicassign

Reference to the filter callback.

This method must return a pointer to the filter callback function that performs audio manipulation. Always return the same pointer - this must not change over time.

Returns
Pointer to a variable speed filter callback

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