语音识别插件
语音识别的电容社区插件.
维护者
| 维护者 | GitHub 图像 | 社会 |
|---|---|---|
| 普里扬克帕特尔 | 缩写 | @priyankpat (英语) |
| 马特奥·帕多万诺 | 牧师 | @mrba7ista (英语) |
维持状况:积极维持
安装
用于 npm
npm install @capacitor-community/speech-recognition
用纱线
yarn add @capacitor-community/speech-recognition
同步本地文件
npx cap sync
iOS系统
iOS 需要为您的应用程序添加并填入以下用户描述 Info.plist数字 :
NSSpeechRecognitionUsageDescription(单位:千美元)Privacy - Speech Recognition Usage Description(中文(简体) )NSMicrophoneUsageDescription(单位:千美元)Privacy - Microphone Usage Description(中文(简体) )
机器人
无需采取进一步行动.
支持的方法
available()start(...)stop()getSupportedLanguages()isListening()checkPermissions()requestPermissions()addListener('partialResults', ...)addListener('listeningState', ...)removeAllListeners()- 接口
- 类型异名
示例
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();
可用( )
available() => Promise<{ available: boolean; }>
这种方法将检查设备上是否有语音识别功能.
回返情况: Promise<{ available: boolean; }>
启动(...)
start(options?: UtteranceOptions | undefined) => Promise<{ matches?: string[]; }>
这种方法将开始倾听言论.
若为 partialResults 实值 true,函数直接响应而无结果
事件 partialResults 将发出每个部分结果,直到停止.
| 参数 | 类型 |
|---|---|
options | UtteranceOptions |
回返情况: Promise<{ matches?: string[]; }>
停止( )
stop() => Promise<void>
这种方法将停止听话
获取支持语言( )
getSupportedLanguages() => Promise<{ languages: any[]; }>
这种方法会返回由语音识别器支持的语言列表.
在Android 13和较新的版本上没有.
回返情况: Promise<{ languages: any[]; }>
正在听( )
isListening() => Promise<{ listening: boolean; }>
这种方法将检查语音识别是否在监听 .
回返情况: Promise<{ listening: boolean; }>
自: 5.1.0 国家
检查( )
checkPermissions() => Promise<PermissionStatus>
检查语音识别权限.
回返情况: Promise<PermissionStatus>
自: 5.0.0 (单位:千美元)
请求( )
requestPermissions() => Promise<PermissionStatus>
请求语音识别许可.
回返情况: Promise<PermissionStatus>
自: 5.0.0 (单位:千美元)
添加倾听器( “ 部分结果 ” , )
addListener(eventName: 'partialResults', listenerFunc: (data: { matches: string[]; }) => void) => Promise<PluginListenerHandle>
当部分结果成真并收到结果时调用.
在Android上,如果弹出是真实的就行不通了.
提供了部分结果.
| 参数 | 类型 |
|---|---|
eventName | 'partialResults' |
listenerFunc | (data: { matches: string[]; }) => void |
回返情况: Promise<PluginListenerHandle>
自: 2.0.2 (中文(简体) )
添加倾听器( “ listening state ” ,...)
addListener(eventName: 'listeningState', listenerFunc: (data: { status: 'started' | 'stopped'; }) => void) => Promise<PluginListenerHandle>
听州变后召入.
| 参数 | 类型 |
|---|---|
eventName | 'listeningState' |
listenerFunc | (data: { status: 'started' | 'stopped'; }) => void |
回返情况: Promise<PluginListenerHandle>
自: 5.1.0 国家
删除所有收听器( )
removeAllListeners() => Promise<void>
删除此插件所附带的所有听众 .
自: 4.0.0 (单位:千美元)
接口
用途选项
| Prop | 类型 | 说明 |
|---|---|---|
language | string | 密钥返回自 getSupportedLanguages() |
maxResults | number | 返回的最大结果数( 5 为最大) |
prompt | string | 弹出时提示要显示的消息( 只有Android) |
popup | boolean | 聆听语音时显示弹出窗口( 只有Android) |
partialResults | boolean | 如果找到, 返回部分结果 |
权限状态
| Prop | 类型 | 说明 | 自兹 |
|---|---|---|---|
speechRecognition | PermissionState | 语音识别别名的授权状态 。 在Android上,它请求/检查记录 AUDIO权限 在iOS上,它要求/检查语音识别和麦克风权限. | 5.0.0 (单位:千美元) |
插件听筒
| Prop | 类型 |
|---|---|
remove | () => Promise<void> |
类型异名
权限状态
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'