Instance Methods | Properties | List of all members
<AEAudioPlayable> Protocol Referenceabstract

AEAudioPlayable protocol. More...

#import <AEAudioController.h>

Inherits <NSObject>.

Inherited by AEAudioUnitChannel, AEBlockChannel, AEMemoryBufferPlayer, and AEPlaythroughChannel.

Instance Methods

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

Properties

AEAudioRenderCallback renderCallback
 Reference to the render callback.
 
float volume
 Track volume.
 
float pan
 Track pan.
 
BOOL channelIsPlaying
 
BOOL channelIsMuted
 
AudioStreamBasicDescription audioDescription
 

Detailed Description

AEAudioPlayable protocol.

The interface that a channel object must implement - this includes 'renderCallback', which is a C callback to be called when audio is required. 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.

Method Documentation

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

Perform setup, to prepare for playback.

Playable 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.

Playable 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

- (AEAudioRenderCallback) renderCallback
readnonatomicassign

Reference to the render callback.

This method must return a pointer to the render callback function that provides the channel audio. Always return the same pointer - this must not change over time.

Returns
Pointer to a render callback function
- (float) volume
readoptionalnonatomicassign

Track volume.

Changes are tracked by Key-Value Observing, so be sure to send KVO notifications when the value changes (or use a readwrite property).

Range: 0.0 to 1.0

- (float) pan
readnonatomicassign

Track pan.

Changes are tracked by Key-Value Observing, so be sure to send KVO notifications when the value changes (or use a readwrite property).

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

- (BOOL) channelIsPlaying
readnonatomicassign
- (BOOL) channelIsMuted
readnonatomicassign
- (AudioStreamBasicDescription) audioDescription
readnonatomicassign
The documentation for this protocol was generated from the following file: