# @capawesome/capacitor-torch 中文文档

规范地址：https://npmcn.com/package/%40capawesome/capacitor-torch/

版本：8\.0\.2
npm 元数据更新时间：2026-09-02T12:54:45.995Z
中文译文更新时间：2026-11-09T04:27:18.910Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40capawesome/capacitor-torch
原文对照：https://npmcn.com/package/%40capawesome/capacitor-torch/?lang=original
项目主页：https://capawesome.io/docs/sdks/capacitor/torch/
源码仓库：https://github.com/capawesome-team/capacitor-plugins

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

- 包体积（解压后）：75.5 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2024-09-12T05:42:03.081Z
- 最新版本发布：2026-09-02T12:54:45.663Z
- 近 30 天下载量：25149（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 4 个）

## 中文简介

在Android,iOS,和Web上切换手电筒的电容插件.

## 安装

```sh
npm install @capawesome/capacitor-torch
```

也可以使用：`pnpm add @capawesome/capacitor-torch`、`yarn add @capawesome/capacitor-torch`、`bun add @capawesome/capacitor-torch`

## README

# 电容火炬插件

用于打开和关闭手电筒的电容插件.

[![Deliver Live Updates to your Capacitor app with Capawesome Cloud](https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1)](https://cloud.capawesome.io/)

## 特征

Capacitor火炬插件是Capacitor应用软件最完整的手电筒控制解决方案之一. 以下是一些关键特征:

-   🖥️ **跨平台**:支持Android,iOS,和Web.
-   🔦 **火炬控制**:启用、禁用并切换火炬/闪光灯.
-   ✅ **可用性检查**:检查设备上是否有火炬.
-   🌐 **网络支持**: 使用MediaStream API进行网络火炬控制.
-   🤝 **兼容性**: 与 [条码扫描](https://capawesome.io/docs/sdks/capacitor/mlkit/barcode-scanning/) 财务报告和审定财务报表 [光感应器](https://capawesome.io/docs/sdks/capacitor/light-sensor/) 插件 .
-   🔁 **最新数据**:总是支持最新的Capacitor版本.

缺少一个功能? 刚刚 [打开一个问题](https://github.com/capawesome-team/capacitor-plugins/issues) 我们看看!

## 使用大小写

通常在应用程序需要控制设备的手电筒时使用火炬插件,例如:

-   **手电筒特性**:打开和关闭手电筒,在您的应用程序中安装一个自带.
-   **条码和 QR 代码扫描**:让用户让火炬在低光环境下扫描代码.
-   **文档抓取**:通过启用火炬来提高黑暗环境中的捕捉质量.
-   **信号**:切换火炬以引起注意,例如作为紧急信号灯.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-torch` plugin in my project.
```

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

```bash
npm install @capawesome/capacitor-torch
npx cap sync
```

### 机器人

#### 权限

此 API 需要将以下权限添加到您 `AndroidManifest.xml` 之前 `application` 标签 :

```xml
<!-- To get access to the flashlight. -->
<uses-permission android:name="android.permission.FLASHLIGHT"/>
```

#### 变量

如果需要, 您可以在您的应用程序中定义以下工程变量 `variables.gradle` 要更改依赖的默认版本的文件 :

-   `$androidxCameraCoreVersion` 版本 `androidx.camera:camera-core` (默认 : `1.5.2`(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

## 配置

此插件不需要配置 .

## 演示

这里有一个实例: [robingenz/电容器-插管-demo](https://github.com/robingenz/capacitor-plugin-demo)

## 使用量

以下例子说明如何检查火炬是否可用,打开并关闭火炬,切换火炬,并检查火炬是否启用.

### 检查火炬是否可用

并非每个设备都有火炬,所以在显示用户界面中的手电筒控制器前先检查可用性:

```typescript
import { Torch } from '@capawesome/capacitor-torch';

const isAvailable = async () => {
    const result = await Torch.isAvailable();
    return result.available;
};
```

### 打开和关闭火炬

启用或禁用火炬 。 在Android上,这些方法需要SDK 23或更新. 在网络上,你可以选择通过自己的 `MediaStream` 与视频轨道通过 `stream` 选项 :

```typescript
import { Torch } from '@capawesome/capacitor-torch';

const enable = async () => {
  await Torch.enable();
};

const disable = async () => {
  await Torch.disable();
};
```

### 切换火炬

将火炬切换到相反的状态,单打一次:

```typescript
import { Torch } from '@capawesome/capacitor-torch';

const toggle = async () => {
  await Torch.toggle();
};
```

### 检查是否启用了火炬

读取当前火炬状态, 例如在您的 UI 中显示状态 :

```typescript
import { Torch } from '@capawesome/capacitor-torch';

const isEnabled = async () => {
    const result = await Torch.isEnabled();
    return result.enabled;
};
```

## API 密码

-   [`enable(...)`](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-enable)
-   [`disable(...)`](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-disable)
-   [`isAvailable()`](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-isavailable)
-   [`isEnabled(...)`](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-isenabled)
-   [`toggle(...)`](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-toggle)
-   [接口](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-interfaces)

### 启用(...)

```typescript
enable(options?: EnableOptions | undefined) => Promise<void>
```

启用火炬.

仅在Android(SDK 23+),iOS和Web上提供.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[EnableOptions](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-enableoptions)` |

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

* * *

### 禁用(...)

```typescript
disable(options?: DisableOptions | undefined) => Promise<void>
```

禁用火炬 .

仅在Android(SDK 23+),iOS和Web上提供.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[DisableOptions](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-disableoptions)` |

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

* * *

### 易读 ()

```typescript
isAvailable() => Promise<IsAvailableResult>
```

检查火炬是否可用 .

仅在Android,iOS和Web上提供.

**回返情况:** `Promise<[IsAvailableResult](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-isavailableresult)>`

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

* * *

### 已启用(...)

```typescript
isEnabled(options?: IsEnabledOptions | undefined) => Promise<IsEnabledResult>
```

检查是否启用了火炬 .

仅在Android,iOS和Web上提供.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[IsEnabledOptions](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-isenabledoptions)` |

**回返情况:** `Promise<[IsEnabledResult](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-isenabledresult)>`

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

* * *

### 切换(...)

```typescript
toggle(options?: ToggleOptions | undefined) => Promise<void>
```

取取取取取来.

仅在Android(SDK 23+),iOS和Web上提供.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[ToggleOptions](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-toggleoptions)` |

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

* * *

### 接口

#### 启用选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`stream`** | `MediaStream` | 使火炬能够打开的媒体流. **请注意**:溪道必须有视频轨道. 视频道的外观模式必须是与火炬相对应的. 仅在Web上提供. | 6.2.0 (单位:千美元) |

#### 禁用选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`stream`** | `MediaStream` | 用于禁用火炬的媒体流. **请注意**:溪道必须有视频轨道. 视频道的外观模式必须是与火炬相对应的. 仅在Web上提供. | 6.2.0 (单位:千美元) |

#### 易伤性结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`available`** | `boolean` | 火炬有无. | 6.0.0 (单位:千美元) |

#### 已启用结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`enabled`** | `boolean` | 是否启用了火炬 . | 6.0.0 (单位:千美元) |

#### 可选选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`stream`** | `MediaStream` | 用于检查火炬是否启用的媒体流 . **请注意**:溪道必须有视频轨道. 视频道的外观模式必须是与火炬相对应的. 仅在Web上提供. | 6.2.0 (单位:千美元) |

#### 切换选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`stream`** | `MediaStream` | 媒体的溪流来切开火炬. **请注意**:溪道必须有视频轨道. 视频道的外观模式必须是与火炬相对应的. 仅在Web上提供. | 6.2.0 (单位:千美元) |

## 财务问题

### 此插件支持哪些平台 ?

该插件可在Android,iOS和Web上找到. 安卓号上 `enable(...)`, (中文(简体) ), `disable(...)` 财务报告和审定财务报表 `toggle(...)` 方法需要SDK 23或更新。 在网络上,插件使用MediaStream API来控制火炬.

### 为什么 `isAvailable` 回到我的装置上?

这个 `isAvailable()` 方法报告当前设备是否提供了火炬。 它回来了 `false` 在没有火炬的设备上,例如许多平板电脑或桌面浏览器。 使用这种方法隐藏或禁用您在此类设备上的手电筒 UI .

### 使用此插件需要任何权限吗 ?

在Android上,你需要添加 `FLASHLIGHT` 允许您使用 `AndroidManifest.xml` 文件,参见 [安装](https://npmcn.com/package/%40capawesome/capacitor-torch/#readme-installation) 节。 iOS上不需要权限.

### 火炬在网络上如何控制??

网络实施使用MediaStream API. 你可以选择通过自己的 `MediaStream` 通过 `stream` 选项 `enable(...)`, (中文(简体) ), `disable(...)`, (中文(简体) ), `isEnabled(...)` 财务报告和审定财务报表 `toggle(...)`. 该流必须有视频道,视频道的外观模式必须是与火炬相对应的.

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [条码扫描](https://capawesome.io/docs/sdks/capacitor/mlkit/barcode-scanning/):用ML Kit Barcode扫描扫描条码和QR码.
-   [光感应器](https://capawesome.io/docs/sdks/capacitor/light-sensor/):读取设备的环境光感应.
-   [屏幕亮度](https://capawesome.io/docs/sdks/capacitor/screen-brightness/):读取并控制屏幕亮度.

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/torch/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/torch/LICENSE)。 。 。 .

## 常见问题

### @capawesome/capacitor-torch 是什么？

在Android,iOS,和Web上切换手电筒的电容插件\.

### 如何安装 @capawesome/capacitor-torch？

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

### @capawesome/capacitor-torch 支持 TypeScript 吗？

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

### @capawesome/capacitor-torch 支持 ESM 还是 CommonJS？

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

### @capawesome/capacitor-torch 可以商用吗？

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

### @capawesome/capacitor-torch 的下载量有多少？

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

### @capawesome/capacitor-torch 还在维护吗？

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