> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# getRecorderManager

获取全局唯一的录音管理器。

## 扫码预览

![扫码预览 getRecorderManager](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fmedia%252Fget-recorder-manager%252Findex)

## 支持版本

前端库版本不低于 `0.0.36`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>不支持</td></tr>
</tbody>
</table>

## 接入准备

### 权限要求

<table>
<thead>
<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td>应用权限</td><td><code>scope.record</code></td><td>必须</td><td>Android、iOS</td><td>需要应用录音授权</td></tr>
<tr><td>系统权限</td><td>麦克风权限</td><td>必须</td><td>Android、iOS</td><td>需要使用系统麦克风录音</td></tr>
</tbody>
</table>

### 授权行为

- **Android**：首次调用 start 时会依次申请应用录音授权和系统麦克风权限；pause、resume、stop 不重复申请。拒绝、取消或撤销授权后 start 失败，再次调用 start 会重新发起仍可展示的授权；系统不再允许弹窗时需在系统设置中开启麦克风权限。
- **iOS**：首次调用 start 时会申请应用录音授权和系统麦克风权限；pause、resume、stop 不重复申请。拒绝或撤销后 start 失败；再次调用 start 可重新发起应用授权，系统麦克风权限需在系统设置中开启。

### 前置条件

- 在应用权限声明中配置 scope.record，并在调用 start 前注册需要的 onError、onStop 和 onFrameRecorded 监听

## 使用说明

- 录音包含用户敏感数据，仅在用户明确操作后开始，并在不再需要时及时调用 stop。
- start.duration 取 1 至 600000 的正整数，单位 ms；start.format 取 aac、pcm 或 wav；start.sampleRate 取 8000、11025、12000、16000、22050、24000、32000、44100 或 48000，单位 Hz。
- start.numberOfChannels 取 1 或 2；start.encodeBitRate 为仅在 AAC 录音时生效的正整数，单位 bps；start.frameSize 取 0 或 1 至 4096 的整数，单位 KB。

## 调用方式

### 同步 API

```typescript
getRecorderManager(): RecorderManager
```

## 入参

无。

## 调用示例

```ts
import { getRecorderManager } from '@doubao-dev/framework/api';

const rm = getRecorderManager();
rm.onError((error) => console.error('录音失败', error.errMsg));
rm.onStop((result) => console.log('录音完成', result.tempFilePath));
rm.start({ duration: 10000, format: 'aac' });
```

## 返回值

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>offError</code></td><td><code>(callback?: RecorderManagerErrorCallback) =&gt; void</code></td><td>是</td><td>取消 error 监听；省略 callback 时移除全部错误监听。</td></tr>
<tr><td><code>offFrameRecorded</code></td><td><code>(callback?: RecorderManagerFrameRecordedCallback) =&gt; void</code></td><td>是</td><td>取消 frameRecorded 监听；省略 callback 时移除全部分片事件监听。</td></tr>
<tr><td><code>offPause</code></td><td><code>(callback?: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>取消 pause 监听；省略 callback 时移除全部暂停事件监听。</td></tr>
<tr><td><code>offResume</code></td><td><code>(callback?: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>取消 resume 监听；省略 callback 时移除全部恢复事件监听。</td></tr>
<tr><td><code>offStart</code></td><td><code>(callback?: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>取消 start 监听；省略 callback 时移除全部开始事件监听。</td></tr>
<tr><td><code>offStop</code></td><td><code>(callback?: RecorderManagerStopCallback) =&gt; void</code></td><td>是</td><td>取消 stop 监听；省略 callback 时移除全部停止事件监听。</td></tr>
<tr><td><code>onError</code></td><td><code>(callback: RecorderManagerErrorCallback) =&gt; void</code></td><td>是</td><td>监听授权、录音状态和录制过程错误；回调参数 errMsg 为错误信息字符串。</td></tr>
<tr><td><code>onFrameRecorded</code></td><td><code>(callback: RecorderManagerFrameRecordedCallback) =&gt; void</code></td><td>是</td><td>监听录音分片事件；需要在 start 时把 frameSize 设置为大于 0。回调参数包含 ArrayBuffer 类型的 frameBuffer 和布尔值 isLastFrame。</td></tr>
<tr><td><code>onPause</code></td><td><code>(callback: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>监听录音暂停事件。</td></tr>
<tr><td><code>onResume</code></td><td><code>(callback: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>监听录音恢复事件。</td></tr>
<tr><td><code>onStart</code></td><td><code>(callback: RecorderManagerStateCallback) =&gt; void</code></td><td>是</td><td>监听录音开始事件。</td></tr>
<tr><td><code>onStop</code></td><td><code>(callback: RecorderManagerStopCallback) =&gt; void</code></td><td>是</td><td>监听录音停止事件。回调参数包含 tempFilePath（字符串）、duration（毫秒）和 fileSize（字节）。</td></tr>
<tr><td><code>pause</code></td><td><code>() =&gt; void</code></td><td>是</td><td>暂停正在进行的录音。</td></tr>
<tr><td><code>resume</code></td><td><code>() =&gt; void</code></td><td>是</td><td>恢复已暂停的录音。</td></tr>
<tr><td><code>start</code></td><td><code>(options?: RecorderManagerStartOptions) =&gt; void</code></td><td>是</td><td>开始录音；省略 options 时使用默认录音配置。duration 默认 60000 ms，format 默认 aac，sampleRate 默认 44100 Hz，numberOfChannels 默认 1，encodeBitRate 默认 128000 bps，frameSize 默认 0 KB。</td></tr>
<tr><td><code>stop</code></td><td><code>() =&gt; void</code></td><td>是</td><td>停止录音并触发 onStop。</td></tr>
</tbody>
</table>

## 平台差异

- **Android**：format 为 pcm 或 wav 时，必须把 frameSize 设置为 1 至 4096；输出文件为 WAV。
- frameSize 大于 0 时使用 PCM 数据分片并输出 WAV 文件，encodeBitRate 不生效。
