跳转至正文

音频会话 Capacitor 插件

配置 iOS audio session,实现后台播放、音频混音及路由控制

安装

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

指南

如何在 Capacitor 中使用 Audio Session

在设备上测试

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

Audio Session 插件预览 QR code

使用 @capgo/capacitor-audio-session

仅限 iOS 的插件,用于查询和控制音频会话输出,并监听路由变化及中断。

安装

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

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

导入

import { AudioSession } from '@capgo/capacitor-audio-session';

API 概览

方法 描述
currentOutputs 获取当前激活的音频输出路由。
overrideOutput 覆盖当前的音频输出路由。

示例

currentOutputs()

获取当前激活的音频输出路由。

import { AudioSession } from '@capgo/capacitor-audio-session';

const result = await AudioSession.currentOutputs();
console.log(result);

overrideOutput()

覆盖当前的音频输出路由。

import { AudioSession } from '@capgo/capacitor-audio-session';

const result = await AudioSession.overrideOutput('default');
console.log(result);

监听事件

addListener 会返回一个句柄。调用 handle.remove() 当屏幕卸载时。

完整参考文档

继续了解使用 @capgo/capacitor-audio-session

如果你正在使用 使用 @capgo/capacitor-audio-session 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-audio-session 有关 @capgo/capacitor-audio-session 中的实现细节, 快速入门 有关“入门指南”中的实现细节, 使用 @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 Session 插件常见问题

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

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

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

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

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

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

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

是的。code 的源代码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-audiosession/,并且你可以通过 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

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

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

无需等待 App 审核,即可发布 Audio Session 的变更

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

开始使用 Capgo