Protocol: AVAudioRecorderDelegate

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.Called when the audio session is interrupted during a recording, such as by an incoming phone call.Called by the system when a recording is stopped or has finished due to reaching its time limit.Called when an audio recorder encounters an encoding error during recording.Called after your audio session interruption ends, with options indicating the state of the audio session.

Instance Method Summary (collapse)

Instance Method Details

- (Object) audioRecorderBeginInterruption(recorder)

Called when the audio session is interrupted during a recording, such as by an incoming phone call. 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.

Parameters:

  • recorder (AVAudioRecorder)

    The audio recorder whose recording was interrupted.

Returns:

- (Object) audioRecorderDidFinishRecording(recorder, successfully:flag)

Called by the system when a recording is stopped or has finished due to reaching its time limit. This method is not called by the system if the audio recorder stopped due to an interruption.

Parameters:

  • recorder (AVAudioRecorder)

    The audio recorder that has finished recording.

  • flag (Boolean)

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

Returns:

- (Object) audioRecorderEncodeErrorDidOccur(recorder, error:error)

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

Parameters:

  • recorder (AVAudioRecorder)

    The audio recorder that encountered the encoding error.

  • error (NSError)

    The encoding error.

Returns:

- (Object) audioRecorderEndInterruption(recorder, withOptions:flags)

Called after your audio session interruption ends, with options indicating the state of the audio session. 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, such as by a user ignoring an incoming phone call, the audio session for your application is automatically reactivated; at that point you can again interact with the audio recorder. To resume recording, call the record method.If this delegate method receives the AVAudioSessionInterruptionOptionShouldResume constant in its flags parameter, the audio session is immediately ready to be used.

Parameters:

  • recorder (AVAudioRecorder)

    The paused audio recorder whose interruption has ended.

  • flags (Integer)

    Options indicating the state of the audio session when this method is called. Options are described in AVAudioSessionInterruptionOptions

Returns: