音视频录制

createMediaRecorder

创建一个音视频录制器实例。

C++

virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0;

在开始录制音频和视频流之前，你需要调用该方法创建一个录制器实例。SDK 支持录制来自本地或远端用户的多个音视频流。你可以多次调用该方法创建多个录制器实例，并通过参数 info 指定要录制的频道名和远端用户 ID。创建成功后，你需要调用 setMediaRecorderObserver 为录制器实例注册观察者以监听相关回调，然后调用 startRecording 开始录制。

参数

info

音视频流信息。详见 RecorderStreamInfo。

返回值

方法调用成功，返回 IMediaRecorder 实例。详见 IMediaRecorder。 方法调用失败，返回 NULL。

所属接口类

• IRtcEngine

destroyMediaRecorder

销毁音视频录制器对象。

C++

virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0;

当你不再需要录制音频和视频流时，可以调用此方法销毁对应的录制器实例。调用此方法前，请确保已调用 stopRecording 停止录制。

参数

mediaRecorder

要销毁的录制器实例。详见 IMediaRecorder。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

setMediaRecorderObserver

注册 IMediaRecorderObserver 观察器。

C++

virtual int setMediaRecorderObserver(media::IMediaRecorderObserver* callback) = 0;

自从

自 v4.0.0 版本新增。

该方法用于设置音视频录制的回调，使应用在录制过程中能够接收录制状态和信息通知。 在调用该方法前，请确保：

• 已创建并初始化 IRtcEngine 对象。
• 已使用 createMediaRecorder 创建媒体录制器对象。

参数

callback

音视频流录制的回调。详见 IMediaRecorderObserver。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IMediaRecorder

startAudioRecording [1/3]

开始客户端音频录制并设置录制采样率。

C++

virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0;

调用该方法后，你可以在通话过程中录制频道中所有用户的音频，并生成包含所有声音的录音文件。录音文件仅支持以下格式：

• .wav：文件体积大，音频保真度高。
• .aac：文件体积小，音频保真度低。

信息

• 确保你指定的路径存在且可写。
• 必须在调用 joinChannel 后调用该方法。如果在录音过程中调用了 leaveChannel，录音将自动停止。

参数

filePath

本地保存录音文件的绝对路径，包括文件名和扩展名。例如：C:\music\audio.aac。

信息

确保指定的路径存在且可写。

quality

录音质量，详见 AUDIO_RECORDING_QUALITY_TYPE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

startAudioRecording [2/3]

开始客户端音频录制并设置录制采样率。

C++

virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0;

调用该方法后，你可以在通话过程中在客户端录制频道中所有用户的音频，并生成包含所有声音的录音文件。录音文件仅支持以下格式：

• .wav：文件体积大，音频保真度高。
• .aac：文件体积小，音频保真度低。

信息

• 请确保在该方法中指定的路径存在且可写。
• 必须在调用 joinChannel 后调用该方法。如果在录音过程中调用 leaveChannel，录音将自动停止。
• 为确保录音质量，当 sampleRate 设置为 44.1 kHz 或 48 kHz 时，建议将 quality 设置为 AUDIO_RECORDING_QUALITY_MEDIUM 或 AUDIO_RECORDING_QUALITY_HIGH。

参数

filePath

本地保存录音文件的绝对路径，包括文件名和扩展名。例如：C:\music\audio.aac。

信息

请确保指定的路径存在且可写。

sampleRate

录音采样率（Hz）。你可以设置为以下值之一：

• 16000
• 32000（默认）
• 44100
• 48000

quality

录音质量，详见 AUDIO_RECORDING_QUALITY_TYPE。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

startAudioRecording [3/3]

开始客户端音频录制，并设置录制参数。

C++

virtual int startAudioRecording(const AudioRecordingConfiguration& config) = 0;

调用 startAudioRecording 方法后，你可以在通话过程中在客户端录制频道中用户的音频，并获取录音文件。录音文件支持以下格式：

• WAV：音频保真度高，文件体积大。例如，在采样率为 32000 Hz 的情况下，10 分钟的录音约为 73 MB。
• AAC：音频保真度较低，文件体积小。例如，在采样率为 32000 Hz 且录音质量设置为 AUDIO_RECORDING_QUALITY_MEDIUM 的情况下，10 分钟的录音约为 2 MB。

当用户离开频道时，录音会自动停止。

调用时机

该方法必须在加入频道后调用。

参数

config

录音配置。详见 AudioRecordingConfiguration。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

startRecording

开始录制音视频流。

C++

virtual int startRecording(const media::MediaRecorderConfiguration& config) = 0;

自从

自 v4.0.0 版本新增。

该方法用于开始录制音频和视频流，支持同时录制本地和远端用户的音视频流。 在调用该方法前，请确保：

• 已通过 createMediaRecorder 创建录制器实例。
• 已通过 setMediaRecorderObserver 注册录制器观察者以监听录制回调。
• 已加入频道。

该方法支持录制以下内容：

• 以 AAC 编码格式采集的麦克风音频。
• 以 H.264 或 H.265 编码格式采集的摄像头视频。

录制开始后：

• 如果录制过程中视频分辨率发生变化，SDK 会停止录制。
• 如果音频采样率或声道数发生变化，SDK 会继续录制，并生成一个 MP4 文件。

仅当检测到可录制的音视频流时，录制文件才会成功生成。如果没有可录制的流，或录制过程中流中断超过 5 秒，SDK 会停止录制，并触发 onRecorderStateChanged（RECORDER_STATE_ERROR，RECORDER_REASON_NO_STREAM）回调。

信息

• 如果你希望录制本地音视频流，请确保在开始录制前将本地用户角色设置为 broadcaster。
• 如果你希望录制远端音视频流，请确保在开始录制前已订阅远端用户的流。

参数

config

音视频流录制配置。详见 MediaRecorderConfiguration。

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。
  • -2：参数无效。请确保：
    • 指定的录制文件路径正确且可写。
    • 指定的录制文件格式正确。
    • 最大录制时长设置正确。
  • -4：IRtcEngine 当前状态不支持该操作。可能是已有录制正在进行，或录制因错误已停止。
  • -7：调用该方法时 IRtcEngine 尚未初始化。请确保在调用该方法前已创建 IMediaRecorder 对象。

所属接口类

• IMediaRecorder

stopAudioRecording

停止客户端音频录制。

C++

virtual int stopAudioRecording() = 0;

返回值

• 0：方法调用成功。
• < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• IRtcEngine

stopRecording

停止音视频流的录制。

C++

virtual int stopRecording() = 0;

自从

自 v4.0.0 版本新增。

信息

调用 startRecording 后，必须调用该方法停止录制，否则生成的录制文件可能无法正常播放。

返回值

• 0：方法调用成功。
• < 0：方法调用失败：
  • -7：调用该方法时 IRtcEngine 未初始化。请确保在调用该方法前已创建 IMediaRecorder 实例。

所属接口类

• IMediaRecorder

onRecorderInfoUpdated

录制信息更新的回调。

C++

virtual void onRecorderInfoUpdated(const char* channelId, rtc::uid_t uid, const RecorderInfo& info) = 0;

自从

自 v4.0.0 版本新增。

成功注册该回调并开始音视频流录制后，SDK 会根据 MediaRecorderConfiguration 中设置的 recorderInfoUpdateInterval 的值定期触发该回调，报告当前录制文件的名称、时长和大小。

触发时机

成功注册该回调并开始音视频流录制后，SDK 会定期触发该回调。

参数

channelId

频道名。

uid

用户 ID。

info

录制文件信息。详见 RecorderInfo。

所属接口类

• IMediaRecorderObserver

onRecorderStateChanged

录制状态发生变化时的回调。

C++

virtual void onRecorderStateChanged(const char* channelId, rtc::uid_t uid, RecorderState state, RecorderReasonCode reason) = 0;

自从

自 v4.0.0 版本新增。

当音视频流的录制状态发生变化时，SDK 会触发该回调，报告当前的录制状态及其变化原因。

参数

channelId

频道名。

uid

用户 ID。

state

当前录制状态。详见 RecorderState。

reason

录制状态变化的原因。详见 RecorderReasonCode。

所属接口类

• IMediaRecorderObserver