Getting Started

安装

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

Listen for presses on the hardware volume buttons.

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

Removes all listeners for this plugin.

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

await VolumeButtons.removeAllListeners();

getPluginVersion

Get the native Capacitor plugin version.

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

如果您正在使用 Getting Started 来规划仪表板和API操作，连接它与 使用@capgo/capacitor-volume-buttons 为native能力在使用@capgo/capacitor-volume-buttons API概述 为API概述的实现细节 介绍 为介绍的实现细节 API 键 了解API 键的实现细节 设备 了解设备的实现细节