跳过内容

开始入门

GitHub

您可以使用我们的 AI 助手设置来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中:

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-volume-buttons` plugin in my project.

如果您更喜欢手动设置,请按照以下命令安装插件并遵循以下平台特定的说明:

终端窗口
bun add @capgo/capacitor-volume-buttons
bunx cap sync
import { VolumeButtons } from '@capgo/capacitor-volume-buttons';

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

getPluginVersion

获取本地 Capacitor 插件版本。

import { VolumeButtons } from '@capgo/capacitor-volume-buttons';
const { version } = await VolumeButtons.getPluginVersion();
console.log('Plugin version:', version);

类型参考

类型参考

VolumeButtonListener

音量按钮监听器

音量按钮事件监听函数。

export type VolumeButtonListener = (event: VolumeButtonPressed) => void;

VolumeButtonPressed

音量按钮按下

音量按钮按下事件数据。

export interface VolumeButtonPressed {
/** Direction of the button press */
direction: VolumeButtonDirection;
}

音量按键方向

export type VolumeButtonDirection = 'up' | 'down';

本页面由插件生成。 src/definitions.ts当公共 API 上游更改时,请重新运行同步。

如果您正在使用 Getting Started 来规划仪表板和 API 操作,请连接它 使用 @capgo/capacitor-volume-buttons 为原生功能使用 @capgo/capacitor-volume-buttons API 概述 为实现细节使用 API 概述 介绍 为实现细节使用 介绍 API 键 为实现细节使用 API 键 设备 为实现细节使用 设备