web-voice-command
Install
npm i web-voice-command
Usage
Compatibility:
Currently only works on chrome. Other browsers do not have support for the Web Speech API as of June 2020.
Options:
- Use setOptions to set the options you need.
- persistentListening: If true listening will be continuous, if false listening will only last four secounds. * When using the startStop method persistentListening option doesn't come into effect. StartStop method will continuously listen until stoped
- listenOnLoad: If ture listening will start when the page loads. If persistentListening is false listening will only last four seconds.
Default options
- persistentListening: false
- listenOnLoad: false
- language: 'en-US'
Methods:
- setOptions: Used to set options
webVoiceCommand
setting language use BCP 47 Language Codes BCP 47 Language Codes:
ar-SA Arabic Saudi Arabia
cs-CZ Czech Czech Republic
da-DK Danish Denmark
de-DE German Germany
el-GR Modern Greek Greece
en-AU English Australia
en-GB English United Kingdom
en-IE English Ireland
en-US English United States
en-ZA English South Africa
es-ES Spanish Spain
es-MX Spanish Mexico
fi-FI Finnish Finland
fr-CA French Canada
fr-FR French France
he-IL Hebrew Israel
hi-IN Hindi India
hu-HU Hungarian Hungary
id-ID Indonesian Indonesia
it-IT Italian Italy
ja-JP Japanese Japan
ko-KR Korean Republic of Korea
nl-BE Dutch Belgium
nl-NL Dutch Netherlands
no-NO Norwegian Norway
pl-PL Polish Poland
pt-BR Portuguese Brazil
pt-PT Portuguese Portugal
ro-RO Romanian Romania
ru-RU Russian Russian Federation
sk-SK Slovak Slovakia
sv-SE Swedish Sweden
th-TH Thai Thailand
tr-TR Turkish Turkey
zh-CN Chinese China
zh-HK Chinese Hong Kong
zh-TW Chinese Taiwan
- results: Returns all voice inputs in arrays that are separated by pauses in voice inputs.
webVoiceCommand
console with voice input "hello world".
2 "hello" "world"
- startStop: Use with DOM events, like button clicks, to start and stop listening. First parameter is either 1 or 2. 1 being one DOM element and 2 being two separate DOM elements, one element sending the value “start” and the other sending the value “stop”.
{ webVoiceCommand}
StartStop
-
wordList: *Requires the persistentListening option to be set to true.
- wordList is used to return only word you listed.
- Without actionsWords: returns an array of words as many time they are vocilized. But will only return words that are listed.
- With actionWords: returns only a single word vocilized after the actionWord and that is listed in the options array as a word.
- Takes three parameters:
- First an array of objects with or without actionWords.
Without actionWords
const words =word:name: 'red'alternateWord:word:name: 'blue'alternateWord:word:name: 'yellow'alternateWord:With actionWords
const words =actionWord:name: 'pick'options:word: 'blue'alternateWord:word: 'red'alternateWord:word: 'yellow'alternateWord:actionWord:name: 'select'options:word: 'home'alternateWord:word: 'about'alternateWord:word: 'contact'alternateWord:- Second a boolean if actionWords are being used.
const withActions = false- Third a callback that returns an array of matched words if you are not using actionWords or a single word if you are using actionWords.
webVoiceCommandconsole without actionWords. Voice input "red blue yellow".
3 "red" "blue" "yellow"console with actionWords. Voice input "select home".
home - wordList is used to return only word you listed.
Author
Matthew Sandoval
- Twitter: @matthewsand0val
- Github: @matoval
- LinkedIn: @matoval