# 音视频录制 (/zh-CN/api-reference/rtc/react-native/recording) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## addListener [#addlistener] 添加一个 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent) 监听器。 ```ts addListener?( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; ``` 成功调用该方法后,你可以通过 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent) 监听对应 [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) 对象的事件、获取数据。根据业务需要,你可以为同一事件添加多个监听器。 ### 参数 [#参数] 需要监听的目标事件名。详见 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent)。 `eventType` 对应的回调函数。以添加 [onRecorderStateChanged](/zh-CN/api-reference/rtc/react-native/recording#callback_imediarecorderobserver_onrecorderstatechanged) 为例: ```text const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged); ``` ### 所属接口类 [#所属接口类] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## createMediaRecorder [#createmediarecorder] 创建音视频录制对象。 ```ts abstract createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder; ``` 在开始音视频流录制前,你需要调用该方法创建一个音视频录制对象。SDK 支持录制本地或远端用户的多个音视频流,你可以多次调用该方法创建录制对象,并通过 `info` 参数指定需要录制的频道名称和发流的用户 ID。 成功创建后,你需要调用 [setMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_setmediarecorderobserver) 注册录制对象的观测器来监听录制的相关回调,然后再调用 [startRecording](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_startrecording) 开始录制。 ### 参数 [#参数-1] 需要录制的音视频流相关信息,详见 [RecorderStreamInfo](/zh-CN/api-reference/rtc/react-native/class-recorderstreaminfo)。 ### 返回值 [#返回值] - 方法调用成功:返回一个 [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) 对象。 - 方法调用失败:返回空指针。 ### 所属接口类 [#所属接口类-1] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## destroyMediaRecorder [#destroymediarecorder] 销毁音视频录制对象。 ```ts abstract destroyMediaRecorder(mediaRecorder: IMediaRecorder): number; ``` 当你不需要再录制音视频流时,可以调用该方法销毁对应的音视频录制对象。如果你正在录制,请先调用 [stopRecording](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_stoprecording) 停止录制,再调用该方法来销毁音视频录制对象。 ### 参数 [#参数-2] 待销毁的 [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) 对象。 ### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## removeAllListeners [#removealllisteners] 移除指定事件的所有监听器。 ```ts removeAllListeners?( eventType?: EventType ): void; ``` ### 参数 [#参数-3] 需要监听的目标事件名。详见 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent)。 ### 所属接口类 [#所属接口类-3] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## removeListener [#removelistener] 移除指定的 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent) 监听器。 ```ts removeListener?( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; ``` ### 参数 [#参数-4] 需要监听的目标事件名。详见 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent)。 `eventType` 对应的回调函数。必须传入 [addListener](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_addlistener_imediarecorder) 中传入的同一个函数对象。以取消监听 [onRecorderStateChanged](/zh-CN/api-reference/rtc/react-native/recording#callback_imediarecorderobserver_onrecorderstatechanged) 为例: ```text const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) => {}; engine.addListener('onRecorderStateChanged', onRecorderStateChanged); engine.removeListener('onRecorderStateChanged', onRecorderStateChanged); ``` ### 所属接口类 [#所属接口类-4] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## setMediaRecorderObserver [#setmediarecorderobserver] 注册 [IMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderobserver) 观测器。 ```ts abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; ``` 该方法用于设置音视频录制的回调,以便在录制过程中向 App 通知音视频流的录制状态和信息。 调用该方法前请确保: - 已创建并初始化 [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 对象。 - 已通过 [createMediaRecorder](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_createmediarecorder) 创建音视频录制对象。 ### 参数 [#参数-5] 音视频流录制回调,详见 [IMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderobserver)。 ### 返回值 [#返回值-2] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-5] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## startAudioRecording [#startaudiorecording] 开始客户端录音并进行录音配置。 ```ts abstract startAudioRecording(config: AudioRecordingConfiguration): number; ``` SDK 支持通话过程中在客户端进行录音。调用该方法后,你可以录制频道内用户的音频,并得到一个录音文件。录音文件仅支持下列格式: - WAV: 音质保真度较高,文件较大。例如,采样率为 32000 Hz,录音时长为 10 分钟的文件大小约为 73 M。 - AAC: 音质保真度较低,文件较小。例如,采样率为 32000 Hz,录音音质为 AudioRecordingQualityMedium,录音时长为 10 分钟的文件大小约为 2 M。 用户离开频道后,录音会自动停止。 ### 调用时机 [#调用时机] 该方法需要在加入频道后调用。 ### 参数 [#参数-6] 录音配置。详见 [AudioRecordingConfiguration](/zh-CN/api-reference/rtc/react-native/class-audiorecordingconfiguration)。 ### 返回值 [#返回值-3] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-6] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## startRecording [#startrecording] 开启音视频流录制。 ```ts abstract startRecording(config: MediaRecorderConfiguration): number; ``` 该方法用于开启音视频流录制。声网 SDK 支持同时录制本地及远端用户的音视频流。 在开始录制前请确保: - 已通过 [createMediaRecorder](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_createmediarecorder) 创建音视频录制对象。 - 已调用 [setMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_setmediarecorderobserver) 注册录制对象观测器来监听录制的相关回调。 - 已加入频道。 该方法支持录制如下数据: - 麦克风采集的、AAC 编码格式的音频。 - 摄像头采集的、H.264 或 H.265 编码格式的视频。 开启音视频流录制后,当视频分辨率在录制过程中发生变化时,SDK 会停止录制;当音频采样率和声道数发生变化时,SDK 会持续录制并生成单个 MP4 录制文件。仅当检测到可录制的音视频流时,才能成功生成录制文件;如果没有可录制的音视频流,或在录制过程中的音视频流中断超过 5 秒后,SDK 会停止录制,并触发 [onRecorderStateChanged](/zh-CN/api-reference/rtc/react-native/recording#callback_imediarecorderobserver_onrecorderstatechanged)(`RecorderStateError, RecorderErrorNoStream`) 回调。 :::note 注: - 如果你需要录制的是本地的音视频流,请在开始录制前确保本地用户的角色设为主播。 - 如果你需要录制的是远端用户的音视频流,请在开始录制前确保已经订阅了该用户的音视频流。 ::: ### 参数 [#参数-7] 音视频流录制配置。详见 [MediaRecorderConfiguration](/zh-CN/api-reference/rtc/react-native/class-mediarecorderconfiguration)。 ### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 - -2: 参数无效。请确保: - 指定的录制文件保存路径正确且可写。 - 指定的录制文件格式正确。 - 设置的最大录制时长正确。 - -4: [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 当前状态不支持该操作。可能因为录制正在进行中或录制出错停止。 - -7: [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 尚未初始化就调用方法。请确认在调用该方法前已创建 [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) 对象。 ### 所属接口类 [#所属接口类-7] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## stopAudioRecording [#stopaudiorecording] 停止客户端录音。 ```ts abstract stopAudioRecording(): number; ``` ### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-8] - [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) ## stopRecording [#stoprecording] 停止音视频流录制。 ```ts abstract stopRecording(): number; ``` :::note 注: 调用 [startRecording](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_startrecording) 后,如果要停止录制,请调用该方法停止录制;否则,生成的录制文件可能无法正常播放。 ::: ### 返回值 [#返回值-6] - 0: 方法调用成功。 - < 0: 方法调用失败: - -7: [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 尚未初始化就调用方法。请确认在调用该方法前已创建 [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) 对象。 ### 所属接口类 [#所属接口类-9] - [IMediaRecorder](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorder) ## onRecorderInfoUpdated [#onrecorderinfoupdated] 录制信息更新回调。 ```ts onRecorderInfoUpdated?( channelId: string, uid: number, info: RecorderInfo ): void; ``` 成功注册该回调并开启音视频流录制后,SDK 会根据你在 [MediaRecorderConfiguration](/zh-CN/api-reference/rtc/react-native/class-mediarecorderconfiguration) 中设置的 `recorderInfoUpdateInterval` 的值周期性触发该回调,报告当前录制文件的文件名、时长和大小。 ### 参数 [#参数-8] 频道名称。 用户 ID。 录制文件信息。详见 [RecorderInfo](/zh-CN/api-reference/rtc/react-native/class-recorderinfo)。 ### 所属接口类 [#所属接口类-10] - [IMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderobserver) ## onRecorderStateChanged [#onrecorderstatechanged] 录制状态发生改变回调。 ```ts onRecorderStateChanged?( channelId: string, uid: number, state: RecorderState, reason: RecorderReasonCode ): void; ``` 音视频流录制状态发生改变时,SDK 会触发该回调,报告当前的录制状态和引起录制状态改变的原因。 ### 参数 [#参数-9] 频道名称。 用户 ID。 当前的录制状态。详见 [RecorderState](/zh-CN/api-reference/rtc/react-native/enum-recorderstate)。 录制状态出错的原因。详见 [RecorderReasonCode](/zh-CN/api-reference/rtc/react-native/enum-recorderreasoncode)。 ### 所属接口类 [#所属接口类-11] - [IMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderobserver)