跳转至正文

音量按钮 Capacitor 插件

监听硬件音量键按压,实现自定义应用控制与快捷键

安装

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

指南

如何在 Capacitor 中使用 Volume Buttons

在设备上测试

下载 Capgo App,然后扫描 code。

Volume Buttons 插件预览二维码 code

使用 @capgo/capacitor-volume-buttons

Capacitor Volume Buttons 插件,用于检测硬件音量键按下事件。

安装

bun add @capgo/capacitor-volume-buttons
bunx cap sync

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

导入

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

API 概览

方法 描述
addListener 监听硬件音量键的按下事件。
removeAllListeners 移除该插件的所有监听器。
getPluginVersion 获取原生 Capacitor 插件版本。

示例

addListener()

监听硬件音量键的按下事件。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

const listener = await VolumeButtons.addListener(
  'volumeButtonPressed',
  (event) => {
    console.log(`Volume ${event.direction} button pressed`);
  }
);

// Remove listener when done
await listener.remove();

removeAllListeners()

移除该插件的所有监听器。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

await VolumeButtons.removeAllListeners();

getPluginVersion()

获取原生 Capacitor 插件版本。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

const { version } = await VolumeButtons.getPluginVersion();
console.log('Plugin version:', version);

监听事件

addListener 返回一个句柄。调用 handle.remove() 当页面卸载时,或 VolumeButtons.removeAllListeners() 以清除所有监听器。

完整参考

继续阅读:使用 @capgo/capacitor-volume-buttons

如果你正在使用 使用 @capgo/capacitor-volume-buttons 要规划原生插件工作,请将其连接到 @capgo/capacitor-volume-buttons 有关 @capgo/capacitor-volume-buttons 中的实现细节, 快速入门 有关入门指南中的实现细节, Capgo 插件目录 用于 Capgo 插件目录中的产品工作流, 由 Capgo 提供的 Capacitor 插件 有关 Capgo 提供的 Capacitor 插件实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Volume Buttons 插件常见问题

如何在 Capacitor 应用中安装 Volume Buttons 插件?

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

@capgo/capacitor-volume-buttons 是否支持 React、Vue 和 Angular?

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

@capgo/capacitor-volume-buttons 支持哪个 Capacitor 版本?

Capgo 插件跟随 Capacitor 的主版本号:插件主版本要与你的 Capacitor 主版本匹配(例如插件 v8 对应 Capacitor 8)。GitHub README 里的兼容性表格列出了仍在维护的版本。

@capgo/capacitor-volume-buttons 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址是 https://github.com/Cap-go/capacitor-volume-buttons/,也可以直接从 npm 免费安装这个包。欢迎提交 Bug 报告和 Pull Request。

使用了 Volume Buttons 的 code 应用,能否不经过 App Store 审核就更新?

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

无需等待应用审核,即可发布 Volume Buttons 的更改

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

立即开始使用 Capgo