音视频流录制
介绍音视频流录制时使用的方法和回调。
createMediaRecorder
创建音视频录制对象。
Future<MediaRecorder?> createMediaRecorder(RecorderStreamInfo info);
详情
在开始音视频流录制前,你需要调用该方法创建一个音视频录制对象。SDK 支持录制本地或远端用户的多个音视频流,你可以多次调用该方法创建录制对象,并通过 info 参数指定需要录制的频道名称和发流的用户 ID。
成功创建后,你需要调用 setMediaRecorderObserver 注册录制对象的观测器来监听录制的相关回调,然后再调用 startRecording 开始录制。
参数
- info
- 需要录制的音视频流相关信息,详见 RecorderStreamInfo。
返回值
- 方法调用成功:返回一个 MediaRecorder 对象。
- 方法调用失败:返回空指针。
destroyMediaRecorder
销毁音视频录制对象。
Future<void> destroyMediaRecorder(MediaRecorder mediaRecorder);
详情
当你不需要再录制音视频流时,可以调用该方法销毁对应的音视频录制对象。如果你正在录制,请先调用 stopRecording 停止录制,再调用该方法来销毁音视频录制对象。
参数
- mediaRecorder
- 待销毁的音视频录制对象。
异常
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。
- < 0: 方法调用失败。
setMediaRecorderObserver
注册 MediaRecorderObserver 观测器。
Future<void> setMediaRecorderObserver( {required RtcConnection connection, required MediaRecorderObserver callback});
详情
该方法用于设置音视频录制的回调,以便在录制过程中向 app 通知音视频流的录制状态和信息。
- 已创建并初始化 RtcEngine 对象。
- 已通过 createMediaRecorder 创建音视频录制对象。
参数
- callback
- 音视频流录制回调,详见 MediaRecorderObserver。
异常
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。
- < 0: 方法调用失败。
startRecording
开启音视频流录制。
Future<void> startRecording(MediaRecorderConfiguration config);
详情
该方法用于开启音视频流录制。声网 SDK 支持同时录制本地及远端用户的音视频流。
- 已通过 createMediaRecorder 创建音视频录制对象。
- 已调用 setMediaRecorderObserver 注册录制对象观测器来监听录制的相关回调。
- 已加入频道。
- 麦克风采集的、AAC 编码格式的音频。
- 摄像头采集的、H.264 或 H.265 编码格式的视频。
开启音视频流录制后,当视频分辨率在录制过程中发生变化时,SDK 会停止录制;当音频采样率和声道数发生变化时,SDK 会持续录制并生成单个 MP4 录制文件。
仅当检测到可录制的音视频流时,才能成功生成录制文件;如果没有可录制的音视频流,或在录制过程中的音视频流中断超过 5 秒后,SDK 会停止录制,并触发 onRecorderStateChanged(recorderStateError, recorderErrorNoStream)
回调。
- 如果你需要录制的是本地的音视频流,请在开始录制前确保本地用户的角色设为主播。
- 如果你需要录制的是远端用户的音视频流,请在开始录制前确保已经订阅了该用户的音视频流。
参数
- config
- 音视频流录制配置。详见 MediaRecorderConfiguration。
异常
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。
- < 0: 方法调用失败。
- -2: 参数无效。请确保:
- 指定的录制文件保存路径正确且可写。
- 指定的录制文件格式正确。
- 设置的最大录制时长正确。
- -4: RtcEngine 当前状态不支持该操作。可能因为录制正在进行中或录制出错停止。
- -7: RtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 MediaRecorder 对象。
- -2: 参数无效。请确保:
stopRecording
停止音视频流录制。
Future<void> stopRecording();
详情
异常
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。
- < 0: 方法调用失败:
- -7: RtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 MediaRecorder 对象。
onRecorderInfoUpdated
录制信息更新回调。
final void Function(String channelId, int uid, RecorderInfo info)? onRecorderInfoUpdated;
成功注册该回调并开启音视频流录制后,SDK 会根据你在 MediaRecorderConfiguration 中设置的 recorderInfoUpdateInterval 的值周期性触发该回调,报告当前录制文件的文件名、时长和大小。
参数
- channelId
- 频道名称。
- uid
- 用户 ID。
- info
- 录制文件信息。详见 RecorderInfo。
onRecorderStateChanged
录制状态发生改变回调。
final void Function(String channelId, int uid, RecorderState state, RecorderErrorCode error)? onRecorderStateChanged;
音视频流录制状态发生改变时,SDK 会触发该回调,报告当前的录制状态和引起录制状态改变的原因。
参数
- channelId
- 频道名称。
- uid
- 用户 ID。
- state
- 当前的录制状态。详见 RecorderState。
- error
- 录制状态出错的原因。详见 RecorderErrorCode。