音视频录制
createMediaRecorder
创建音视频录制对象。
public abstract createMediaRecorder(info: RecorderStreamInfo): AgoraMediaRecorder;
详情
在开始音视频流录制前，你需要调用该方法创建一个音视频录制对象。SDK 支持录制本地或远端用户的多个音视频流，你可以多次调用该方法创建录制对象，并通过 info 参数指定需要录制的频道名称和发流的用户 ID。
成功创建后，你需要调用 setMediaRecorderObserver 注册录制对象的观测器来监听录制的相关回调，然后再调用 startRecording 开始录制。
参数
- info
- 需要录制的音视频流相关信息，详见 RecorderStreamInfo。
返回值
- 方法调用成功：返回一个 AgoraMediaRecorder 实例。
- 方法调用失败：返回空指针。
destroyMediaRecorder
销毁音视频录制对象。
public abstract destroyMediaRecorder(recorder: AgoraMediaRecorder): void;
详情
当你不需要再录制音视频流时，可以调用该方法销毁对应的音视频录制对象。如果你正在录制，请先调用 stopRecording 停止录制，再调用该方法来销毁音视频录制对象。
参数
- recorder
- 待销毁的 AgoraMediaRecorder 对象。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setMediaRecorderObserver
注册 IMediaRecorderCallback 观测器。
public abstract setMediaRecorderObserver(callback: IMediaRecorderCallback | null): number;
详情
该方法用于设置音视频录制的回调，以便在录制过程中向 App 通知音视频流的录制状态和信息。
- 已创建并初始化 RtcEngine 对象。
- 已通过 createMediaRecorder 创建音视频录制对象。
参数
- callback
- 音视频流录制回调，详见 IMediaRecorderCallback。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startAudioRecording
开始客户端录音。
public abstract startAudioRecording(filePath: string, quality: Constants.AudioRecordingQualityType): number;;
详情
.wav: 文件大，音质保真度高；.aac: 文件小，有一定的音质保真度损失。
请确保 App 里指定的目录存在且可写。该接口需在 joinChannelWithOptions 之后调用。如果调用 leaveChannel 时还在录音，录音会自动停止。
参数
- filePath
- 录音文件在本地保存的绝对路径，需精确到文件名及格式。例如：
/sdcard/emulated/0/audio.aac。注意请确保你指定的路径存在并且可写。
- quality
- 录音质量。详见 AudioRecordingQuality。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startAudioRecordingWithConfiguration
开始客户端录音并进行录音配置。
public abstract startAudioRecordingWithConfiguration(config: AudioRecordingConfiguration): number;
- WAV: 音质保真度较高，文件较大。例如，采样率为 32000 Hz，录音时长为 10 分钟的文件大小约为 73 M。
- AAC: 音质保真度较低，文件较小。例如，采样率为 32000 Hz，录音音质为 MEDIUM，录音时长为 10 分钟的文件大小约为 2 M。
用户离开频道后，录音会自动停止。
调用时机
该方法需要在加入频道后调用。
调用限制
无。
参数
- config
- 录音配置。详见 AudioRecordingConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startRecording
开启音视频流录制。
public abstract startRecording(config: MediaRecorderConfiguration): number;
详情
该方法用于开启音视频流录制。声网 SDK 支持同时录制本地及远端用户的音视频流。
- 已通过 createMediaRecorder 创建音视频录制对象。
- 已调用 setMediaRecorderObserver 注册录制对象观测器来监听录制的相关回调。
- 已加入频道。
- 麦克风采集的、AAC 编码格式的音频。
- 摄像头采集的、H.264 或 H.265 编码格式的视频。
开启音视频流录制后，当视频分辨率在录制过程中发生变化时，SDK 会停止录制；当音频采样率和声道数发生变化时，SDK 会持续录制并生成单个 MP4 录制文件。
仅当检测到可录制的音视频流时，才能成功生成录制文件；如果没有可录制的音视频流，或在录制过程中的音视频流中断超过 5 秒后，SDK 会停止录制，并触发 onRecorderStateChanged(RECORDER_STATE_ERROR, RECORDER_ERROR_NO_STREAM) 回调。
- 如果你需要录制的是本地的音视频流，请在开始录制前确保本地用户的角色设为主播。
- 如果你需要录制的是远端用户的音视频流，请在开始录制前确保已经订阅了该用户的音视频流。
参数
- config
- 音视频流录制配置。详见 MediaRecorderConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 参数无效。请确保：
- 指定的录制文件保存路径正确且可写。
- 指定的录制文件格式正确。
- 设置的最大录制时长正确。
- -4: RtcEngine 当前状态不支持该操作。可能因为录制正在进行中或录制出错停止。
- -7: RtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 AgoraMediaRecorder 对象。
- -2: 参数无效。请确保：
stopAudioRecording
stopRecording
停止音视频流录制。
public abstract stopRecording(): number;
详情
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败：
- -7: RtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 AgoraMediaRecorder 对象。
onRecorderInfoUpdated
录制信息更新回调。
onRecorderInfoUpdated(channelId: string, uid: number, info: RecorderInfo): void;
详情
成功注册该回调并开启音视频流录制后，SDK 会根据你在 MediaRecorderConfiguration 中设置的 recorderInfoUpdateInterval 的值周期性触发该回调，报告当前录制文件的文件名、时长和大小。
参数
- channelId
- 频道名称。
- uid
- 用户 ID。
- info
- 录制文件信息。详见 RecorderInfo。
onRecorderStateChanged
录制状态发生改变回调。
onRecorderStateChanged(channelId: string, uid: number, state: number, reason: number): void;
详情
音视频流录制状态发生改变时，SDK 会触发该回调，报告当前的录制状态和引起录制状态改变的原因。
参数
- channelId
- 频道名称。
- uid
- 用户 ID。
- state
- 当前的录制状态：
- RECORDER_STATE_ERROR（-1）：音视频流录制出错。
- RECORDER_STATE_START（2）：音视频流录制开始。
- RECORDER_STATE_STOP（3）：音视频流录制停止。
- error
- 录制状态出错的原因：
- RECORDER_REASON_NONE（0）：一切正常。
- RECORDER_ERROR_WRITE_FAILED（1）：录制文件写入失败。
- RECORDER_ERROR_NO_STREAM（2）：没有可录制的音视频流或者录制的音视频流中断超过 5 秒。
- RECORDER_ERROR_OVER_MAX_DURATION（3）：录制时长超出上限。
- RECORDER_ERROR_CONFIG_CHANGED（4）：录制配置改变。