开始

安装

您可以使用我们的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';

API 概述

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);

类型参考

VolumeButtonListener

音量按钮事件监听函数。

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

VolumeButtonPressed

音量按钮按下的事件数据

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

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 中的实现细节 设备 为设备