AEAudioUnitChannel Class Reference

Audio Unit Channel. More...

#import <AEAudioUnitChannel.h>

Inherits <NSObject>, and <AEAudioPlayable>.

Inherited by AEAudioFilePlayer.

Instance Methods

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

Properties

float volume
 Track volume.
 
float pan
 Track pan.
 
BOOL channelIsPlaying
 
BOOL channelIsMuted
 
AudioUnit audioUnit
 The audio unit.
 
AUNode audioGraphNode
 The audio graph node.
 
- Properties inherited from <AEAudioPlayable>
AEAudioRenderCallback renderCallback
 Reference to the render callback.
 
float volume
 Track volume.
 
float pan
 Track pan.
 
BOOL channelIsPlaying
 
BOOL channelIsMuted
 
AudioStreamBasicDescription audioDescription
 

Detailed Description

Audio Unit Channel.

This class allows you to add Audio Units as channels. 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 channel.

Parameters
audioComponentDescriptionThe structure that identifies the audio unit
Returns
The initialised channel
- (id) initWithComponentDescription: (AudioComponentDescription)  audioComponentDescription
preInitializeBlock: (AudioUnit audioUnit preInitializeBlock 

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

Parameters
audioComponentDescriptionThe structure that identifies the audio unit
preInitializeBlockA 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 channel
- (AudioUnit) AEAudioUnitChannelGetAudioUnit (__unsafe_unretained AEAudioUnitChannel *)  channel

Retrieve audio unit reference.

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

Parameters
channelThe channel
Returns
Audio unit reference
- (double) getParameterValueForId: (AudioUnitParameterID)  parameterId

Get an audio unit parameter.

Parameters
parameterIdThe 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
valueThe value of the parameter to set
parameterIdThe audio unit parameter identifier

Property Documentation

- (float) volume
readwritenonatomicassign

Track volume.

Range: 0.0 to 1.0

- (float) pan
readwritenonatomicassign

Track pan.

Range: -1.0 (left) to 1.0 (right)

- (BOOL) channelIsPlaying
readwritenonatomicassign
- (BOOL) channelIsMuted
readwritenonatomicassign
- (AudioUnit) audioUnit
readnonatomicassign

The audio unit.

- (AUNode) audioGraphNode
readnonatomicassign

The audio graph node.


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