跳转至正文

音频录制器 Capacitor 插件

在 iOS、Android 和 Web 上用简单的控件和格式录制音频

安装

bun add @capgo/capacitor-audio-recorder bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-audio-recorder
  • pnpm add @capgo/capacitor-audio-recorder
  • yarn add @capgo/capacitor-audio-recorder

指南

如何在 Capacitor 中使用 Audio Recorder

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Audio Recorder 插件预览二维码 code

使用 @capgo/capacitor-audio-recorder

使用 Capacitor 插件进行音频录制。

安装

bun add @capgo/capacitor-audio-recorder
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

API 概览

方法 描述
startRecording 使用设备麦克风开始录音。
pauseRecording 暂停正在进行的录音。仅支持 Android (API 24+)、iOS 和 Web。
resumeRecording 恢复之前暂停的录音。
stopRecording 停止当前录音并保存录制的音频。
cancelRecording 取消当前录音并丢弃已捕获的音频。
getRecordingStatus 获取当前录音状态。
getCurrentAmplitude 以归一化数值的形式获取当前输入振幅(麦克风电平)。 [0, 1] 指定区间内。
checkPermissions 返回麦克风访问权限的当前状态。
requestPermissions 请求访问麦克风的权限。

示例

startRecording()

使用设备麦克风开始录音。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.startRecording();

pauseRecording()

暂停正在进行的录音。仅支持 Android (API 24+)、iOS 和 Web。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.pauseRecording();

resumeRecording()

恢复之前暂停的录音。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.resumeRecording();

stopRecording()

停止当前录音并保存录制的音频。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

const result = await CapacitorAudioRecorder.stopRecording();
console.log(result);

cancelRecording()

取消当前录音并丢弃已捕获的音频。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.cancelRecording();

getRecordingStatus()

获取当前录音状态。

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

const result = await CapacitorAudioRecorder.getRecordingStatus();
console.log(result);

上表列出了 9 个核心方法。监听器、版本辅助函数以及每个方法的完整规范,请参阅 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时,或者调用 CapacitorAudioRecorder.removeAllListeners() 以清除所有监听器。

完整参考文档

继续阅读:使用 @capgo/capacitor-audio-recorder

如果你正在使用 使用 @capgo/capacitor-audio-recorder 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-audio-recorder 了解 @capgo/capacitor-audio-recorder 中的实现细节, 快速入门 有关“入门指南”中的实现细节, 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力, @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节,以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力

常见问题

Audio Recorder 插件常见问题

如何在 Capacitor 应用中安装 Audio Recorder 插件?

运行 "bun add @capgo/capacitor-audio-recorder" (或 "npm install @capgo/capacitor-audio-recorder"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步 native code。最后在你的应用 code 中从 "@capgo/capacitor-audio-recorder" 导入即可。

@capgo/capacitor-audio-recorder 是否支持 React、Vue 和 Angular?

支持。Audio Recorder 是一个 Capacitor 包,因此它支持任何在 Capacitor 中运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-audio-recorder 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-audio-recorder 是免费开源的吗?

是的。code 已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-audio-recorder/,该包也可从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下更新使用了 Audio Recorder 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App Store 审核,即可快速发布 Audio Recorder 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo