AEModule Class Reference

Module base class. More...

#import <AEModule.h>

Inherits NSObject.

Inherited by AEAudiobusInputModule, AEAudioFileRecorderModule, AEAudioUnitInputModule, AEAudioUnitModule, AEMixerModule, AEOscillatorModule, AESplitterModule, and AESubrendererModule.

Instance Methods

(instancetype _Nullable) - initWithRenderer:
 Initializer.
 
(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

AEModuleProcessFunc _Nonnull processFunction
 Process function.
 
AEModuleIsActiveFunc _Nullable isActiveFunction
 Active test function.
 
AERenderer *_Nullable renderer
 The renderer.
 

Detailed Description

Module base class.

Modules are the basic processing unit, and all provide a function to perform processing. Processing is invoked by calling AEModuleProcess and passing in the module.

Method Documentation

- (instancetype _Nullable) initWithRenderer: (AERenderer *_Nullable)  NS_DESIGNATED_INITIALIZER
- (instancetype _Nonnull) NS_UNAVAILABLE
- (void) rendererDidChangeSampleRate

Notifies the module that the renderer's sample rate has changed.

Subclasses may override this method to react to sample rate changes.

- (void) rendererDidChangeNumberOfChannels

Notifies the module that the renderer's channel count has changed.

Subclasses may override this method to react to channel count changes.

Property Documentation

- (AEModuleProcessFunc _Nonnull) processFunction
readwritenonatomicassign

Process function.

All subclasses must set this property to the address of their processing function to be able to process audio.

- (AEModuleIsActiveFunc _Nullable) isActiveFunction
readwritenonatomicassign

Active test function.

Subclasses may set this property to the address of a function that returns whether or not the module is currently active. If it returns NO, the module is considered inactive and processing can be skipped by client code.

- (AERenderer* _Nullable) renderer
readwritenonatomicweak

The renderer.

This may be re-assigned after initialization; the module will begin tracking the parameters of the new renderer.


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