开始入门
复制一个设置提示,包含安装步骤和该插件的完整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.
您可以使用我们的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-buttonsbunx cap sync导入
标题为“导入”import { VolumeButtons } from '@capgo/capacitor-volume-buttons';API概述
标题为“API概述”addListener
标题为“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 doneawait listener.remove();removeAllListeners
标题: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
标题:VolumeButtonListener音量按钮事件的监听函数。
export type VolumeButtonListener = (event: VolumeButtonPressed) => void;VolumeButtonPressed
Section titled “VolumeButtonPressed”音量按钮按下事件数据
export interface VolumeButtonPressed { /** Direction of the button press */ direction: VolumeButtonDirection;}VolumeButtonDirection
Section titled “VolumeButtonDirection”音量按钮按下方向
export type VolumeButtonDirection = 'up' | 'down';真实数据来源
Section titled “真实数据来源”本页面由插件生成, src/definitions.ts当公共API上游更改时,请重新运行同步。
如果您正在使用 入门 为了计划仪表板和API操作,连接它与 使用@capgo/capacitor-volume-buttons 对于本地能力的使用@capgo/capacitor-volume-buttons API概述 对于API概述的实现细节 介绍 对于介绍的实现细节 API密钥 对于API密钥的实现细节 设备 设备详细信息的实现细节。