跳过主要内容

音量按钮 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应用,扫描QRcode

音量按钮插件预览QRcode

使用@capgo/capacitor-volume-buttons

Capacitor音量按钮插件,用于检测硬件音量按钮按压

安装

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-音量按钮 为 @capgo/capacitor-volume-buttons 的实现细节 开始使用 为 Getting Started 的实现细节 Capgo 插件目录 为 Capgo 插件目录中的产品工作流程 Capacitor 由 Capgo 提供的插件 为 Capacitor 由 Capgo 提供的插件的实现细节,并且 添加或更新插件 为添加或更新插件的实现细节

FAQ

常见问题

如何在Capacitor应用中安装音量按钮插件?

Run "bun add @capgo/capacitor-volume-buttons" (or "npm install @capgo/capacitor-volume-buttons"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-volume-buttons" in your app code.

是否@capgo/capacitor-volume-buttons与React、Vue和Angular兼容?

是的。音量按钮是一个 Capacitor 包,因此它可以与任何运行在 Capacitor 内的 Web 框架一起工作,包括 Ionic、React、Vue、Angular、Svelte 和普通的 JavaScript。

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

Capgo 插件遵循 Capacitor 的主要版本:使用与 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。兼容性表格在 GitHub README 中列出已维护的版本。

是否 @capgo/capacitor-volume-buttons 免费且开源?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-volume-buttons/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在不经过 App Store 审核的情况下更新使用音量按钮的 code?

安装或升级插件会更改本机 code,因此需要新建一个商店构建。之后,JavaScript、HTML 和 CSS 的更改可以立即通过 Capgo 实时更新。

在等待应用程序审查之前,推送Volume Buttons的更改

一旦插件在您的商店构建中,Capgo实时更新将推送您的JavaScript、HTML和CSS更改给用户几分钟内。

开始使用 Capgo