开始使用

复制一个包含安装步骤和此插件的完整Markdown指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-volume-buttons`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/volume-buttons/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

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. 当 upstream 的公共 API 变更时，请重新同步。