AEAudioUnitFilter Class Reference

Audio Unit Filter. More...

#import <AEAudioUnitFilter.h>

Inherits <NSObject>, and <AEAudioFilter>.

Instance Methods
(id)	- initWithComponentDescription:
	Create a new Audio Unit filter.
(id)	- initWithComponentDescription:preInitializeBlock:
	Create a new Audio Unit filter, with a block to run before initialization of the unit.
(AudioUnit)	- AEAudioUnitFilterGetAudioUnit
	Retrieve audio unit reference.
(double)	- getParameterValueForId:
	Get an audio unit parameter.
(void)	- setParameterValue:forId:
	Set an audio unit parameter.
Instance Methods inherited from <AEAudioFilter>
(void)	- setupWithAudioController:
	Perform setup, to prepare for playback.
(void)	- teardown
	Clean up resources.

Properties
AudioUnit	audioUnit
	The audio unit.
AUNode	audioGraphNode
	The audio graph node.
BOOL	bypassed
	Audio Unit effect bypass.
BOOL	useDefaultInputFormatWorkaround
	Whether to always use the audio unit's default input audio format.
Properties inherited from <AEAudioFilter>
AEAudioFilterCallback	filterCallback
	Reference to the filter callback.

Detailed Description

Audio Unit Filter.

This class allows you to use Audio Units as filters. Provide an AudioComponentDescription that describes the audio unit, and the corresponding audio unit will be initialised, ready for use

Method Documentation

- (id) initWithComponentDescription:

(AudioComponentDescription)

audioComponentDescription

Create a new Audio Unit filter.

Parameters

audioComponentDescription

The structure that identifies the audio unit

Returns

The initialised filter

- (id) initWithComponentDescription:		(AudioComponentDescription)	audioComponentDescription
preInitializeBlock:		(AudioUnit audioUnit)	preInitializeBlock

Create a new Audio Unit filter, with a block to run before initialization of the unit.

Parameters

audioComponentDescription	The structure that identifies the audio unit
preInitializeBlock	A block to run before the audio unit is initialized. This can be used to set some properties that needs to be set before the unit is initialized.

Returns

The initialised filter

- (AudioUnit) AEAudioUnitFilterGetAudioUnit

(__unsafe_unretained AEAudioUnitFilter *)

filter

Retrieve audio unit reference.

This method, for use on the realtime audio thread, allows subclasses and external classes to access the audio unit.

Parameters

filter

The filter

Returns

Audio unit reference

- (double) getParameterValueForId:

(AudioUnitParameterID)

parameterId

Get an audio unit parameter.

Parameters

parameterId

The audio unit parameter identifier

Returns

The value of the parameter

- (void) setParameterValue:		(double)	value
forId:		(AudioUnitParameterID)	parameterId

Set an audio unit parameter.

Note: Parameters set via this method will be automatically assigned again if the audio unit is recreated due to removal from the audio controller, an audio controller reload, or a media server error.

Parameters

value	The value of the parameter to set
parameterId	The audio unit parameter identifier

Property Documentation

- (AudioUnit) audioUnit

readnonatomicassign

The audio unit.

- (AUNode) audioGraphNode

readnonatomicassign

The audio graph node.

- (BOOL) bypassed

readwritenonatomicassign

Audio Unit effect bypass.

Default is false.

Toggle this state at any time and it will begin taking effect on the next render cycle.

- (BOOL) useDefaultInputFormatWorkaround

readwritenonatomicassign

Whether to always use the audio unit's default input audio format.

This can be used as a workaround for audio units that misidentify the TAAE system audio description as being compatible. Audio will automatically be converted from the source audio format to this format.

Default: NO

---

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

• AEAudioUnitFilter.h