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

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

版本：8\.0\.1
npm 元数据更新时间：2026-10-23T21:48:07.414Z
中文译文更新时间：2026-11-09T04:43:48.902Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：48.4 kB，26 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2024-01-08T08:14:39.877Z
- 最新版本发布：2026-07-24T07:25:27.546Z
- 近 30 天下载量：13863（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 2 个）

## 中文简介

电容 音量按钮. 插件允许收听硬件音量按钮

## 安装

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

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

## README

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 音量按钮插件

**`@capacitor-community/volume-buttons`**

听取硬件音量按钮的电容社区插件

![](https://img.shields.io/maintenance/yes/2026?style=flat-square) [![](https://img.shields.io/npm/l/@capacitor-community/volume-buttons?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/volume-buttons)  
[![](https://img.shields.io/npm/dw/@capacitor-community/volume-buttons?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/volume-buttons) [![](https://img.shields.io/npm/v/@capacitor-community/volume-buttons?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/volume-buttons) [![](https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square)](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-contributors-)

## 目录

-   [维护者](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-maintainers)
-   [关于](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-about)
-   [插件版本](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-plugin-versions)
-   [支持的平台](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-supported-platforms)
-   [安装](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-installation)
-   [API 密码](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-api)
-   [解决问题](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-troubleshooting)

## 维护者

| 维护者 | GitHub 图像 | 活动 |
| --- | --- | --- |
| 尼亚a | [尼亚a](https://github.com/ryaa) | 对 |

## 关于

此插件允许在用户按下设备的硬件音量上下键时监听所引发的事件. 仅包含一个属性的对象被转到回调 - 见 [音量按钮](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-VolumeButtonsResult)。 。 。 . 此插件包含源自或启发的代码 [https://github.com/CipherBitCorp/VolumeButtonHandler 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/CipherBitCorp/VolumeButtonHandler) 财务报告和审定财务报表 [https://github.com/thiagobrez/ 电容-容量-按钮](https://github.com/thiagobrez/capacitor-volume-buttons) 插件 .

  

**特征 :**

-   支持最大音量或分( 确保使用) 时接收事件 **`disableSystemVolumeHandler`** iOS 平台 - 见 [音量按钮选项](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-VolumeButtonsOptions)(中文(简体) )
-   继续接收发送到应用程序后的事件,并从背景返回
-   支持 Android 和 iOS 平台

**页:1**:插件版本8.x与Capacitor 8兼容

## 插件版本

| 电容版本 | 插件版本 |
| --- | --- |
| 8.x 电话 | 8.x 电话 |
| 7.x 电话 | 7.x 电话 |
| 6.x (单位:千美元) | 6.x (单位:千美元) |
| 5.x 电话 | 1.x 运算 |

## 支持的平台

-   iOS系统
-   机器人

## 安装

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

## API 密码

-   [`isWatching()`](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-iswatching)
-   [`watchVolume(...)`](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-watchvolume)
-   [`clearWatch()`](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-clearwatch)
-   [接口](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-type-aliases)

### 正在观察 ()

```typescript
isWatching() => Promise<GetIsWatchingResult>
```

获取音量按钮的监视状态 .

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

**自:** 1.0.1 (中文(简体) )

* * *

### 监视卷(...)

```typescript
watchVolume(options: VolumeButtonsOptions, callback: VolumeButtonsCallback) => Promise<CallbackID>
```

为他设置手表 硬件音量按钮更改

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[VolumeButtonsOptions](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-volumebuttonsoptions)` |
| **`callback`** | `[VolumeButtonsCallback](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-volumebuttonscallback)` |

**回返情况:** `Promise<string>`

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

* * *

### 清除监视( C)

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

清除已有的表

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

* * *

### 接口

#### 获取监视结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`value`** | `boolean` | 如果音量按钮被监视. | 1.0.1 (中文(简体) ) |

#### 音量按钮选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`disableSystemVolumeHandler`** | `boolean` | 此参数可用于禁用系统音量处理器(仅iOS). 如果这是真的,当调取上下音量按钮时,系统音量将总是被重置到初始音量(启动音量按钮跟踪/上传时的音量),如果初始音量较小,则重置到0.05;如果初始音量较大,则重置到0.95. | 1.0.0 (单位:千美元) |
| **`suppressVolumeIndicator`** | `boolean` | 此参数可用于压制/隐藏系统体积指标(仅Android,它从未在iOS上显示过). 如果这是真的,当调用上下音量按钮时,系统音量指示器将不会显示. 默认值是虚假的 . | 1.0.2 联合国 |

#### 音量按钮

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`direction`** | `'up' | 'down'` | 这表明按下了音量上下键. | 1.0.0 (单位:千美元) |

### 类型异名

#### 调回音量按钮

`(result: [VolumeButtonsResult](https://npmcn.com/package/%40capacitor-community/volume-buttons/#readme-volumebuttonsresult), err?: any): void`

#### 调用回话ID

`string`

## 使用量

请参看 **示例应用程序** 一个完整的例子.

### 在应用程序中添加音量按钮监听器

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

const options: VolumeButtonsOptions = {};
const callback: VolumeButtonsCallback = (result: VolumeButtonsResult, err?: any) => {
  console.log('result', result);
};
if (this.platform.is('ios')) {
  options.disableSystemVolumeHandler = true;
} else if (this.platform.is('android')) {
  options.suppressVolumeIndicator = true;
}
await VolumeButtons.watchVolume(options, callback);
```

### 删除应用程序中的音量按钮监听器

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

await VolumeButtons.clearWatch();
```

## 常见问题

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

电容 音量按钮\. 插件允许收听硬件音量按钮

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

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

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

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

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

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

### @capacitor-community/volume-buttons 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

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

@capacitor-community/volume-buttons 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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