iPhone OS Reference Library Apple Developer Connection spyglass button

AVAudioRecorderDelegate Protocol Reference

Conforms to
Framework
/System/Library/Frameworks/AVFoundation.framework
Availability
Available in iPhone OS 3.0 and later.
Declared in
AVAudioRecorder.h

Overview

The delegate of an AVAudioRecorder object must adopt the AVAudioRecorderDelegate protocol. All of the methods in this protocol are optional. They allow a delegate to respond to audio interruptions and audio decoding errors, and to the completion of a recording.

Tasks

Responding to the Completion of a Recording

Responding to an Audio Encoding Error

Handling Audio Interruptions

Instance Methods

audioRecorderBeginInterruption:

Called when the audio session is interrupted during a recording, such as by an incoming phone call.

- (void)audioRecorderBeginInterruption:(AVAudioRecorder *)recorder

Parameters
recorder

The audio recorder whose recording was interrupted.

Discussion

Upon interruption, your application’s audio session is deactivated and the audio recorder pauses. You cannot use the audio recorder again until you receive a notification that the interruption has ended.

Availability
  • Available in iPhone OS 3.0 and later.
Declared In
AVAudioRecorder.h

audioRecorderDidFinishRecording:successfully:

Called by the system when a recording is stopped or has finished due to reaching its time limit.

- (void)audioRecorderDidFinishRecording:(AVAudioRecorder *)recorder successfully:(BOOL)flag

Parameters
recorder

The audio recorder that has finished recording.

flag

TRUE on successful completion of recording; FALSE if recording stopped because of an audio encoding error.

Discussion

This method is not called by the system if the audio recorder stopped due to an interruption.

Availability
  • Available in iPhone OS 3.0 and later.
Declared In
AVAudioRecorder.h

audioRecorderEncodeErrorDidOccur:error:

Called when an audio recorder encounters an encoding error during recording.

- (void)audioRecorderEncodeErrorDidOccur:(AVAudioRecorder *)recorder error:(NSError *)error

Parameters
recorder

The audio recorder that encountered the encoding error.

error

The encoding error.

Availability
  • Available in iPhone OS 3.0 and later.
Declared In
AVAudioRecorder.h

audioRecorderEndInterruption:

Called when an interruption ends, such as by a user ignoring an incoming phone call.

- (void)audioRecorderEndInterruption:(AVAudioRecorder *)recorder

Parameters
recorder

The paused audio recorder whose interruption has ended.

Discussion

For an audio recorder’s delegate to receive this message, the audio recorder must have been recording when the interruption started. When an interruption ends, the audio session for your application is automatically reactivated, allowing your application to interact with the audio recorder. To resume recording, call the record method.

Availability
  • Available in iPhone OS 3.0 and later.
Declared In
AVAudioRecorder.h


Last updated: 2009-11-17

Did this document help you? Yes It's good, but... Not helpful...