# @capgo/capacitor-volume-buttons 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-volume-buttons/

版本：8\.1\.6
npm 元数据更新时间：2026-10-15T04:54:13.100Z
中文译文更新时间：2026-11-09T04:02:45.884Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-volume-buttons
原文对照：https://npmcn.com/package/%40capgo/capacitor-volume-buttons/?lang=original
项目主页：https://capgo.app/docs/plugins/volume-buttons/
源码仓库：https://github.com/Cap-go/capacitor-volume-buttons

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：55 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-10-09T16:37:45.006Z
- 最新版本发布：2026-10-15T04:54:12.620Z
- 近 30 天下载量：40300（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 24 个）

## 中文简介

听音量按钮的电容插件

## 安装

```sh
npm install @capgo/capacitor-volume-buttons
```

也可以使用：`pnpm add @capgo/capacitor-volume-buttons`、`yarn add @capgo/capacitor-volume-buttons`、`bun add @capgo/capacitor-volume-buttons`

## README

# @ capgo/ 容积按钮

响应您的 Capacitor app 中的硬件音量按钮, 拍照, 翻出一页或触发任何动作 .

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-volume-buttons)](https://capgo.app/?ref=plugin_volume_buttons)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_volume_buttons)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_volume_buttons) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-volume-buttons` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _添加@capgo/capor- opulation- 按钮到我的Capacitor app上,并把它接上。"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_volume_buttons) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_volume_buttons)

![@capgo/capacitor-volume-buttons for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-volume-buttons/main/assets/github-social-preview.png)

## 主要特点

-   **按钮事件**页:1 `volumeButtonPressed` 听众报告 `up` 或者说 `down`。 。 。 .
-   **iOS系统**: 注意音频会话输出音量.
-   **机器人**: 听卷关键事件.
-   **清理**数字 : `removeAllListeners()` 移除你的听众。 当插件实例被销毁时, 原生监控停止 .
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 在网上不可用.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/量-按钮/](https://capgo.app/docs/plugins/volume-buttons/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

## 安装

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

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-volume-buttons
npx cap sync
```

## API 密码

-   [`addListener('volumeButtonPressed', ...)`](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-addlistenervolumebuttonpressed-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-removealllisteners)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-type-aliases)

用于检测硬件音量按钮的电容按钮插件.

### 添加倾听器( “ opulations Button Pressed ” ,...)

```typescript
addListener(eventName: 'volumeButtonPressed', listenerFunc: VolumeButtonListener) => Promise<PluginListenerHandle> & PluginListenerHandle
```

听从硬件音量按钮上的按键.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`eventName`** | `'volumeButtonPressed'` | \- 事件名称( 必须是 “ 批量按钮前置 ” ) |
| **`listenerFunc`** | `[VolumeButtonListener](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-volumebuttonlistener)` | \- 在按下音量按钮时调用功能 |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-pluginlistenerhandle)> & [PluginListenerHandle](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-pluginlistenerhandle)`

**自:** 1.0.0 (单位:千美元)

* * *

### 删除所有收听器( )

```typescript
removeAllListeners() => Promise<void>
```

删除此插件的所有听众 .

**自:** 1.0.0 (单位:千美元)

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

获取本地 Capacitor 插件版本 .

**回返情况:** `Promise<{ version: string; }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 接口

#### 插件听筒

| Prop | 类型 |
| --- | --- |
| **`remove`** | `() => Promise<void>` |

#### 音量按钮前置

用于按音量按钮的事件数据 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`direction`** | `[VolumeButtonDirection](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-volumebuttondirection)` | 按钮的取向 |

### 类型异名

#### 音量按钮监听器

音量按钮事件的收听器功能 .

`(event: [VolumeButtonPressed](https://npmcn.com/package/%40capgo/capacitor-volume-buttons/#readme-volumebuttonpressed)): void`

#### 音量按钮方向

音量按钮的方向 .

`'up' | 'down'`

## 常见问题

### @capgo/capacitor-volume-buttons 是什么？

听音量按钮的电容插件

### 如何安装 @capgo/capacitor-volume-buttons？

在项目目录运行 npm install @capgo/capacitor-volume-buttons，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-volume-buttons 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-volume-buttons 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-volume-buttons 可以商用吗？

@capgo/capacitor-volume-buttons 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-volume-buttons 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-volume-buttons 在 2026/10/09 – 2026/11/07 这 30 天内被下载 40,300 次，日均约 1,343 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-volume-buttons 还在维护吗？

最新版本 8\.1\.6 发布于 2026/10/15（25 天前）；至今共发布 38 个版本，其中过去 12 个月发布了 24 个；首次发布于 2025/10/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。