# @capacitor-community/speech-recognition 中文文档

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

版本：7\.0\.1
npm 元数据更新时间：2026-10-23T21:47:58.735Z
中文译文更新时间：2026-11-09T01:53:15.951Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：71.6 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=7\.0\.0
- 首次发布：2020-06-25T01:56:59.820Z
- 最新版本发布：2025-06-09T13:54:29.992Z
- 近 30 天下载量：463085（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

语音识别的本地插件

## 安装

```sh
npm install @capacitor-community/speech-recognition
```

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

## README

# 语音识别插件

语音识别的电容社区插件.

## 维护者

| 维护者 | GitHub 图像 | 社会 |
| --- | --- | --- |
| 普里扬克帕特尔 | [缩写](https://github.com/priyankpat) | [@priyankpat (英语)](https://twitter.com/priyankpat_) |
| 马特奥·帕多万诺 | [牧师](https://github.com/mrbatista) | [@mrba7ista (英语)](https://twitter.com/mrba7ista) |

维持状况:积极维持

## 安装

用于 npm

```bash
npm install @capacitor-community/speech-recognition
```

用纱线

```bash
yarn add @capacitor-community/speech-recognition
```

同步本地文件

```bash
npx cap sync
```

## iOS系统

iOS 需要为您的应用程序添加并填入以下用户描述 `Info.plist`数字 :

-   `NSSpeechRecognitionUsageDescription` (单位:千美元)`Privacy - Speech Recognition Usage Description`(中文(简体) )
-   `NSMicrophoneUsageDescription` (单位:千美元)`Privacy - Microphone Usage Description`(中文(简体) )

## 机器人

无需采取进一步行动.

## 支持的方法

-   [`available()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-available)
-   [`start(...)`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-start)
-   [`stop()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-stop)
-   [`getSupportedLanguages()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-getsupportedlanguages)
-   [`isListening()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-islistening)
-   [`checkPermissions()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-checkpermissions)
-   [`requestPermissions()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-requestpermissions)
-   [`addListener('partialResults', ...)`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-addlistenerpartialresults-)
-   [`addListener('listeningState', ...)`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-addlistenerlisteningstate-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-removealllisteners)
-   [接口](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-type-aliases)

## 示例

```typescript
import { SpeechRecognition } from "@capacitor-community/speech-recognition";

SpeechRecognition.available();

SpeechRecognition.start({
  language: "en-US",
  maxResults: 2,
  prompt: "Say something",
  partialResults: true,
  popup: true,
});
// listen to partial results
SpeechRecognition.addListener("partialResults", (data: any) => {
  console.log("partialResults was fired", data.matches);
});

// stop listening partial results
SpeechRecognition.removeAllListeners();

SpeechRecognition.stop();

SpeechRecognition.getSupportedLanguages();

SpeechRecognition.checkPermissions();

SpeechRecognition.requestPermissions();

SpeechRecognition.hasPermission();

SpeechRecognition.requestPermission();
```

### 可用( )

```typescript
available() => Promise<{ available: boolean; }>
```

这种方法将检查设备上是否有语音识别功能.

**回返情况:** `Promise<{ available: boolean; }>`

* * *

### 启动(...)

```typescript
start(options?: UtteranceOptions | undefined) => Promise<{ matches?: string[]; }>
```

这种方法将开始倾听言论.

若为 `partialResults` 实值 `true`,函数直接响应而无结果 事件 `partialResults` 将发出每个部分结果,直到停止.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UtteranceOptions](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-utteranceoptions)` |

**回返情况:** `Promise<{ matches?: string[]; }>`

* * *

### 停止( )

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

这种方法将停止听话

* * *

### 获取支持语言( )

```typescript
getSupportedLanguages() => Promise<{ languages: any[]; }>
```

这种方法会返回由语音识别器支持的语言列表.

在Android 13和较新的版本上没有.

**回返情况:** `Promise<{ languages: any[]; }>`

* * *

### 正在听( )

```typescript
isListening() => Promise<{ listening: boolean; }>
```

这种方法将检查语音识别是否在监听 .

**回返情况:** `Promise<{ listening: boolean; }>`

**自:** 5.1.0 国家

* * *

### 检查( )

```typescript
checkPermissions() => Promise<PermissionStatus>
```

检查语音识别权限.

**回返情况:** `Promise<[PermissionStatus](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-permissionstatus)>`

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

* * *

### 请求( )

```typescript
requestPermissions() => Promise<PermissionStatus>
```

请求语音识别许可.

**回返情况:** `Promise<[PermissionStatus](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-permissionstatus)>`

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

* * *

### 添加倾听器( “ 部分结果 ” , )

```typescript
addListener(eventName: 'partialResults', listenerFunc: (data: { matches: string[]; }) => void) => Promise<PluginListenerHandle>
```

当部分结果成真并收到结果时调用.

在Android上,如果弹出是真实的就行不通了.

提供了部分结果.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'partialResults'` |
| **`listenerFunc`** | `(data: { matches: string[]; }) => void` |

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

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

* * *

### 添加倾听器( “ listening state ” ,...)

```typescript
addListener(eventName: 'listeningState', listenerFunc: (data: { status: 'started' | 'stopped'; }) => void) => Promise<PluginListenerHandle>
```

听州变后召入.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'listeningState'` |
| **`listenerFunc`** | `(data: { status: 'started' | 'stopped'; }) => void` |

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

**自:** 5.1.0 国家

* * *

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

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

删除此插件所附带的所有听众 .

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

* * *

### 接口

#### 用途选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`language`** | `string` | 密钥返回自 `getSupportedLanguages()` |
| **`maxResults`** | `number` | 返回的最大结果数( 5 为最大) |
| **`prompt`** | `string` | 弹出时提示要显示的消息( 只有Android) |
| **`popup`** | `boolean` | 聆听语音时显示弹出窗口( 只有Android) |
| **`partialResults`** | `boolean` | 如果找到, 返回部分结果 |

#### 权限状态

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`speechRecognition`** | `[PermissionState](https://npmcn.com/package/%40capacitor-community/speech-recognition/#readme-permissionstate)` | 语音识别别名的授权状态 。 在Android上,它请求/检查记录 AUDIO权限 在iOS上,它要求/检查语音识别和麦克风权限. | 5.0.0 (单位:千美元) |

#### 插件听筒

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

### 类型异名

#### 权限状态

`'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'`

## 常见问题

### @capacitor-community/speech-recognition 是什么？

语音识别的本地插件

### 如何安装 @capacitor-community/speech-recognition？

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

### @capacitor-community/speech-recognition 支持 TypeScript 吗？

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

### @capacitor-community/speech-recognition 支持 ESM 还是 CommonJS？

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

### @capacitor-community/speech-recognition 可以商用吗？

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

### @capacitor-community/speech-recognition 的下载量有多少？

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

### @capacitor-community/speech-recognition 还在维护吗？

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