<AEAudioReceiver> Protocol Referenceabstract

AEAudioReceiver protocol. More...

#import <AEAudioController.h>

Inherits <NSObject>.

Inherited by AEBlockAudioReceiver, AEPlaythroughChannel, and AERecorder.

Instance Methods

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

Properties

AEAudioReceiverCallback receiverCallback
 Reference to the receiver callback.
 

Detailed Description

AEAudioReceiver protocol.

The interface that a object must implement to receive incoming or outgoing output audio. This includes 'receiverCallback', which is a C callback to be called when audio is available. 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 to receive audio.

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

Filter 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

- (AEAudioReceiverCallback) receiverCallback
readnonatomicassign

Reference to the receiver callback.

This method must return a pointer to the receiver callback function that accepts received audio. Always return the same pointer - this must not change over time.

Returns
Pointer to an audio callback

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