# 音视频录制 (/zh-CN/api-reference/rtc/android/recording)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_recording"></a>

<a id="api_irtcengine_createmediarecorder"></a>

<a id="ariaid-title2"></a>

## createMediaRecorder [#createmediarecorder]

创建用于音视频录制的录制器实例。

<a id="api_irtcengine_createmediarecorder__prototype"></a>

```java
public abstract AgoraMediaRecorder createMediaRecorder(RecorderStreamInfo info);
```

<a id="api_irtcengine_createmediarecorder__detailed_desc"></a>

在开始录制音视频流之前，你需要调用该方法创建一个录制器实例。你可以多次调用该方法创建多个录制器，并通过 `info` 参数指定要录制的频道名和用户 ID。

成功创建录制器后，你需要调用 [setMediaRecorderObserver](/zh-CN/api-reference/rtc/android/recording#api_imediarecorder_setmediarecorderobserver) 为录制器注册观察者以监听录制相关的回调，然后调用 [startRecording](/zh-CN/api-reference/rtc/android/recording#api_imediarecorder_startrecording) 开始录制。

<a id="api_irtcengine_createmediarecorder__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="info"></a>
<Parameter name="info">

要录制的音视频流的信息。详见 [RecorderStreamInfo](/zh-CN/api-reference/rtc/android/class-recorderstreaminfo)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_createmediarecorder__return_values"></a>

### 返回值 [#返回值]

- 方法调用成功，返回 [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder) 实例。
- 方法调用失败，返回 `null`。

### 所属接口类 [#所属接口类]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_destroymediarecorder"></a>

<a id="ariaid-title3"></a>

## destroyMediaRecorder [#destroymediarecorder]

销毁音视频录制器实例。

<a id="api_irtcengine_destroymediarecorder__prototype"></a>

```java
public abstract void destroyMediaRecorder(AgoraMediaRecorder mediaRecorder);
```

<a id="api_irtcengine_destroymediarecorder__detailed_desc"></a>

如果当前正在录制，请先调用 [stopRecording](/zh-CN/api-reference/rtc/android/recording#api_imediarecorder_stoprecording) 停止录制，再调用 [destroyMediaRecorder](/zh-CN/api-reference/rtc/android/recording#api_irtcengine_destroymediarecorder) 销毁录制器实例。

<a id="api_irtcengine_destroymediarecorder__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="mediarecorder"></a>
<Parameter name="mediaRecorder">

要销毁的录制器实例。详见 [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_destroymediarecorder__return_values"></a>

### 返回值 [#返回值-1]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_imediarecorder_setmediarecorderobserver"></a>

<a id="ariaid-title4"></a>

## setMediaRecorderObserver [#setmediarecorderobserver]

注册一个用于音视频录制的回调观察者。

<a id="api_imediarecorder_setmediarecorderobserver__prototype"></a>

```java
public int setMediaRecorderObserver(IMediaRecorderCallback callback)
```

<a id="api_imediarecorder_setmediarecorderobserver__detailed_desc"></a>

:::info[自从]
自 v4.0.0 版本新增。
:::

:::note
注： 在调用该方法前，请确保：

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) 对象已创建并初始化。
- 已通过 [createMediaRecorder](/zh-CN/api-reference/rtc/android/recording#api_irtcengine_createmediarecorder) 创建音视频录制对象。
:::

<a id="api_imediarecorder_setmediarecorderobserver__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="callback"></a>
<Parameter name="callback">

音视频流录制的回调。详见 [IMediaRecorderCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorderobserver)。

</Parameter>
</ParameterList>

<a id="api_imediarecorder_setmediarecorderobserver__return_values"></a>

### 返回值 [#返回值-2]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-2]

- [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder)

<a id="api_irtcengine_startaudiorecording1"></a>

<a id="ariaid-title5"></a>

## startAudioRecording [1/2] [#startaudiorecording-12]

开始客户端录音。

<a id="api_irtcengine_startaudiorecording1__prototype"></a>

```java
public abstract int startAudioRecording(String filePath, int quality);
```

<a id="api_irtcengine_startaudiorecording1__detailed_desc"></a>

你必须在调用 `joinChannel` 后调用该方法。调用 `leaveChannel` 时，录音会自动停止。

请确保指定的目录存在且可写。

:::note
注： 调用该方法时，默认的录音采样率为 32 kHz，且无法更改。
:::

<a id="api_irtcengine_startaudiorecording1__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="filepath"></a>
<Parameter name="filePath">

本地保存录音文件的绝对路径，包括文件名和扩展名。例如：/sdcard/emulated/0/audio.aac。

:::note
注： 请确保指定路径存在且可写。
:::

</Parameter>
<a id="quality"></a>
<Parameter name="quality">

录音质量：

- 0：低质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 1.2 MB。
- 1：中等质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 2 MB。
- 2：高质量。采样率为 32 kHz，录制 10 分钟的文件大小约为 3.75 MB。

</Parameter>
</ParameterList>

<a id="api_irtcengine_startaudiorecording1__return_values"></a>

### 返回值 [#返回值-3]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_startaudiorecording3"></a>

<a id="ariaid-title6"></a>

## startAudioRecording [2/2] [#startaudiorecording-22]

开始客户端录制并应用录制配置。

<a id="api_irtcengine_startaudiorecording3__prototype"></a>

```java
public abstract int startAudioRecording(AudioRecordingConfiguration config);
```

<a id="api_irtcengine_startaudiorecording3__detailed_desc"></a>

调用该方法后，你可以录制频道中用户的音频并获取录音文件。录音文件仅支持以下格式：

- WAV：音频保真度高但文件较大。例如，在 32000 Hz 采样率下，10 分钟录音约为 73 MB。
- AAC：音频保真度较低但文件较小。例如，在 32000 Hz 采样率和 `AUDIO_RECORDING_QUALITY_MEDIUM` 录音质量下，10 分钟录音约为 2 MB。

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

<a id="api_irtcengine_startaudiorecording3__timing"></a>

### 调用时机 [#调用时机]

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

<a id="api_irtcengine_startaudiorecording3__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="config"></a>
<Parameter name="config">

录制配置。详见 [AudioRecordingConfiguration](/zh-CN/api-reference/rtc/android/class-audiorecordingconfiguration)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_startaudiorecording3__return_values"></a>

### 返回值 [#返回值-4]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-4]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_imediarecorder_startrecording"></a>

<a id="ariaid-title7"></a>

## startRecording [#startrecording]

开始录制音频和视频流。

<a id="api_imediarecorder_startrecording__prototype"></a>

```java
public int startRecording(MediaRecorderConfiguration config)
```

<a id="api_imediarecorder_startrecording__detailed_desc"></a>

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

- 已使用 [createMediaRecorder](/zh-CN/api-reference/rtc/android/recording#api_irtcengine_createmediarecorder) 创建媒体录制器对象。
- 已使用 [setMediaRecorderObserver](/zh-CN/api-reference/rtc/android/recording#api_imediarecorder_setmediarecorderobserver) 注册媒体录制器观察者以监听录制相关的回调。
- 已加入频道。

该方法支持录制以下数据：

- 由麦克风采集的音频，格式为 AAC。
- 由摄像头采集的视频，格式为 H.264 或 H.265。

录制开始后，如果视频分辨率发生变化，SDK 会停止录制；如果音频采样率或声道数发生变化，SDK 会继续录制并生成一个 MP4 文件。仅当检测到可录制的音视频流时，才会生成录制文件。如果没有可录制的流，或录制过程中音视频流中断超过 5 秒，SDK 会停止录制并触发 [onRecorderStateChanged](/zh-CN/api-reference/rtc/android/recording#callback_imediarecorderobserver_onrecorderstatechanged)（`RECORDER_STATE_ERROR`, `RECORDER_REASON_NO_STREAM`）回调。

:::note
注：

- 如果需要录制本地音视频流，请确保本地用户角色在开始录制前已设置为主播。
- 如果需要录制远端用户的音视频流，请确保在开始录制前已订阅远端用户的音视频流。
:::

<a id="api_imediarecorder_startrecording__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="config-1"></a>
<Parameter name="config">

音视频流录制的配置。详见 [MediaRecorderConfiguration](/zh-CN/api-reference/rtc/android/class-mediarecorderconfiguration)。

</Parameter>
</ParameterList>

<a id="api_imediarecorder_startrecording__return_values"></a>

### 返回值 [#返回值-5]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

  - -2：参数无效。请确保：

    - 指定的录制文件保存路径正确且可写。
    - 指定的录制文件格式正确。
    - 最大录制时长设置正确。
  - -4：当前 [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) 状态不支持该操作。可能是录制已在进行中，或因错误而停止。
  - -7：在 [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) 初始化前调用该方法。请确保在调用该方法前已创建 [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder) 对象。

### 所属接口类 [#所属接口类-5]

- [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder)

<a id="api_irtcengine_stopaudiorecording"></a>

<a id="ariaid-title8"></a>

## stopAudioRecording [#stopaudiorecording]

停止客户端录制音频。

<a id="api_irtcengine_stopaudiorecording__prototype"></a>

```java
public abstract int stopAudioRecording();
```

<a id="api_irtcengine_stopaudiorecording__detailed_desc"></a>

<a id="api_irtcengine_stopaudiorecording__return_values"></a>

### 返回值 [#返回值-6]

- 0：方法调用成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-6]

- [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine)

<a id="api_imediarecorder_stoprecording"></a>

<a id="ariaid-title9"></a>

## stopRecording [#stoprecording]

停止录制音视频流。

<a id="api_imediarecorder_stoprecording__prototype"></a>

```java
public int stopRecording()
```

<a id="api_imediarecorder_stoprecording__detailed_desc"></a>

:::note
注： 调用 [startRecording](/zh-CN/api-reference/rtc/android/recording#api_imediarecorder_startrecording) 后，如果你想停止录制，必须调用此方法；否则生成的录制文件可能无法正常播放。
:::

<a id="api_imediarecorder_stoprecording__return_values"></a>

### 返回值 [#返回值-7]

- 0：方法调用成功。
- &lt; 0：方法调用失败：

  - -7：在初始化 [RtcEngine](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_irtcengine) 之前调用该方法。请确保在调用此方法之前已创建 `Recorder` 实例。

### 所属接口类 [#所属接口类-7]

- [AgoraMediaRecorder](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorder)

<a id="callback_imediarecorderobserver_onrecorderinfoupdated"></a>

<a id="ariaid-title10"></a>

## onRecorderInfoUpdated [#onrecorderinfoupdated]

录制信息更新回调。

<a id="callback_imediarecorderobserver_onrecorderinfoupdated__prototype"></a>

```java
void onRecorderInfoUpdated(String channelId, int uid, RecorderInfo info)
```

<a id="callback_imediarecorderobserver_onrecorderinfoupdated__detailed_desc"></a>

在你成功注册该回调并开始音视频流录制后，SDK 会根据你在 [MediaRecorderConfiguration](/zh-CN/api-reference/rtc/android/class-mediarecorderconfiguration) 中设置的 `recorderInfoUpdateInterval` 的值定期触发该回调，报告当前录制文件的名称、时长和大小。

<a id="callback_imediarecorderobserver_onrecorderinfoupdated__timing"></a>

### 触发时机 [#触发时机]

该回调在你成功注册回调并开始音视频流录制后，根据 [MediaRecorderConfiguration](/zh-CN/api-reference/rtc/android/class-mediarecorderconfiguration) 中设置的 `recorderInfoUpdateInterval` 定期触发。

<a id="callback_imediarecorderobserver_onrecorderinfoupdated__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="channelid"></a>
<Parameter name="channelId">

频道名。

</Parameter>
<a id="uid"></a>
<Parameter name="uid">

用户 ID。

</Parameter>
<a id="info-1"></a>
<Parameter name="info">

录制文件信息，详见 [RecorderInfo](/zh-CN/api-reference/rtc/android/class-recorderinfo)。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-8]

- [IMediaRecorderCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorderobserver)

<a id="callback_imediarecorderobserver_onrecorderstatechanged"></a>

<a id="ariaid-title11"></a>

## onRecorderStateChanged [#onrecorderstatechanged]

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

<a id="callback_imediarecorderobserver_onrecorderstatechanged__prototype"></a>

```java
@CalledByNative void onRecorderStateChanged(String channelId, int uid, int state, int reason);
```

<a id="callback_imediarecorderobserver_onrecorderstatechanged__detailed_desc"></a>

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

<a id="callback_imediarecorderobserver_onrecorderstatechanged__parameters"></a>

### 参数 [#参数-7]

<ParameterList>
<a id="channelid-1"></a>
<Parameter name="channelId">

频道名。

</Parameter>
<a id="uid-1"></a>
<Parameter name="uid">

用户 ID。

</Parameter>
<a id="state"></a>
<Parameter name="state">

当前录制状态：

- `RECORDER_STATE_ERROR`（-1）：录制过程中发生错误。
- `RECORDER_STATE_START`（2）：开始录制音视频流。
- `RECORDER_STATE_STOP`（3）：停止录制音视频流。

</Parameter>
<a id="reason"></a>
<Parameter name="reason">

录制状态变化的原因：

- `RECORDER_REASON_NONE`（0）：一切正常。
- `RECORDER_REASON_WRITE_FAILED`（1）：录制文件写入失败。
- `RECORDER_REASON_NO_STREAM`（2）：无可用音视频流，或音视频流中断超过 5 秒。
- `RECORDER_REASON_OVER_MAX_DURATION`（3）：录制时长超过最大限制。
- `RECORDER_REASON_CONFIG_CHANGED`（4）：录制配置发生变化。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-9]

- [IMediaRecorderCallback](/zh-CN/api-reference/rtc/android/rtc-interface-class#class_imediarecorderobserver)