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, and this page is available as Markdown at /apps-plugin/docs/js-api/media/getRecorderManager.md.

getRecorderManager

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

扫码预览

扫码预览 getRecorderManager

支持版本

前端库版本不低于 0.0.36。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片不支持

接入准备

权限要求

类型标识是否必须平台说明
应用权限scope.record必须Android、iOS需要应用录音授权
系统权限麦克风权限必须Android、iOS需要使用系统麦克风录音

授权行为

  • 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

getRecorderManager(): RecorderManager

入参

无。

调用示例

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' });

返回值

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

平台差异

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