AEMixerModule Class Reference

Mixer module. More...

#import <AEMixerModule.h>

Inherits AEModule.

Instance Methods
(instancetype _Nullable)	- initWithRenderer:
	Initializer.
(void)	- addModule:
	Add a module.
(void)	- addModule:volume:balance:
	Add a module, with mix parameters.
(void)	- removeModule:
	Remove a module.
(void)	- setVolume:balance:forModule:
	Set mixing parameters for a module.
(void)	- getVolume:balance:forModule:
	Get mixing parameters for a module.
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
NSArray *_Nonnull	modules
	The generator modules to aggregate.
int	numberOfChannels
	The number of channels to use (2 by default)
Properties inherited from AEModule
AEModuleProcessFunc _Nonnull	processFunction
	Process function.
AEModuleIsActiveFunc _Nullable	isActiveFunction
	Active test function.
AERenderer *_Nullable	renderer
	The renderer.

Detailed Description

Mixer module.

This module provides a convenient way to aggregate multiple generator modules together, with facilities for applying volume and balance per-generator module.

You should use this with generator modules only - that is, modules that push a buffer onto the stack when they are processed.

Method Documentation

- (instancetype _Nullable) initWithRenderer:

(AERenderer *_Nullable)

renderer

Initializer.

Implements AEModule.

- (void) addModule:

(AEModule *_Nonnull)

module

Add a module.

Parameters

module

A generator module

- (void) addModule:		(AEModule *_Nonnull)	module
volume:		(float)	volume
balance:		(float)	balance

Add a module, with mix parameters.

Parameters

module	A generator module
volume	The module's initial volume (power ratio)
balance	The module's initial balance (0 for center)

- (void) removeModule:

(AEModule *_Nonnull)

module

Remove a module.

Parameters

module

The module to remove

- (void) setVolume:		(float)	volume
balance:		(float)	balance
forModule:		(AEModule *_Nonnull)	module

Set mixing parameters for a module.

Parameters

volume	The module's volume (power ratio)
balance	The module's balance (0 for center)
module	A module

- (void) getVolume:		(float *_Nonnull)	volume
balance:		(float *_Nonnull)	balance
forModule:		(AEModule *_Nonnull)	module

Get mixing parameters for a module.

Parameters

volume	On output, the module's volume (power ratio)
balance	On output, the module's balance (0 for center)
module	A module

Property Documentation

- (NSArray* _Nonnull) modules

readwritenonatomicstrong

The generator modules to aggregate.

- (int) numberOfChannels

readwritenonatomicassign

The number of channels to use (2 by default)

---

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

• AEMixerModule.h