跳转至正文

音量键 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 中使用音量按钮

在设备上测试

下载 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 项目获取原生 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