AgoraMediaRecorder Class Reference

Inherits <NSObject>.

Instance Methods
(int)	- setMediaRecorderDelegate:
(int)	- startRecording:
(int)	- stopRecording

Method Documentation

setMediaRecorderDelegate:

- (int) setMediaRecorderDelegate:

(id< AgoraMediaRecorderDelegate > _Nullable)

delegate

Registers the AgoraMediaRecorderDelegate observer.

Since

v4.0.0

This method sets the callback for audio and video recording, so that the app can be notified of the recording status and information of the audio and video stream during the recording process. Before calling this method, make sure that:

• You have created and initialized the AgoraRtcEngineKit object.
• You have created the recorder using createMediaRecorder:.

Parameters

delegate

The callback for audio and video stream recording. See AgoraMediaRecorderDelegate for details.

Returns

• 0: The method call succeeds.
• < 0: The method call fails. See Error Codes for details and troubleshooting suggestions.

startRecording:

- (int) startRecording:

(AgoraMediaRecorderConfiguration *_Nonnull)

config

Starts audio and video stream recording.

Since

v4.0.0

This method starts recording audio and video streams. The Agora SDK supports recording both local and remote users' audio and video streams simultaneously.

Before starting the recording, make sure that:

• You have created a media recorder object using createMediaRecorder:.
• You have registered a media recorder observer using setMediaRecorderDelegate: to listen for recording-related callbacks.
• You have joined a channel.

This method supports recording the following data:

• Audio captured by the microphone in AAC encoding format.
• Video captured by the camera in H.264 or H.265 encoding format.

After recording starts, if the video resolution changes during the recording process, the SDK stops recording. If the audio sample rate or channel count changes, the SDK continues recording and generates a single MP4 recording file.

A recording file is generated only when recordable audio or video streams are detected. If there are no recordable audio or video streams, or if the streams are interrupted for more than 5 seconds during recording, the SDK stops recording and triggers the mediaRecorder:stateDidChanged:uid:state:reason: (AgoraMediaRecorderStateError, AgoraMediaRecorderReasonCodeNoStream) callback.

Note

• If you want to record the local audio and video streams, make sure the local user's role is set to broadcaster before starting the recording.
• If you want to record remote users' audio and video streams, make sure you have subscribed to the target user's audio and video streams before starting the recording.

Parameters

config

The configuration for audio and video stream recording. See AgoraMediaRecorderConfiguration for details.

Returns

• 0: The method call succeeds.
• < 0: The method call fails. See Error Codes for details and troubleshooting.
  • -2: Invalid parameter. Make sure that:
    • The specified file path for saving the recording is correct and writable.
    • The specified recording file format is correct.
    • The maximum recording duration is set correctly.
  • -4: The current state of AgoraRtcEngineKit does not support this operation. This may be due to an ongoing recording or a recording error that caused it to stop.
  • -7: AgoraRtcEngineKit is not initialized when the method is called. Make sure that the AgoraMediaRecorder object is created before calling this method.

stopRecording

- (int) stopRecording

Stops recording the audio and video stream.

Since

v4.0.0

Note

After calling startRecording:, if you want to stop recording, you must call this method; otherwise, the generated recording file may not play properly.

Returns

• 0: The method call succeeds.
• < 0: The method call fails:
  • -7: The method is called before AgoraRtcEngineKit is initialized. Make sure you have created the Recorder object before calling this method.