react-native-voice-recognizer
v1.0.2
Published
A tiny lib for open native platform voice regonizer in react native.
Downloads
1
Readme
react-native-voice-recognizer:microphone:
A tiny lib for open native platform voice regonizer in react native.
Motivation
react-native-community
provides an awesome @react-native-community/voice for reconiting voice but sometimes you don't want to create your own voice reconizer also you want only recogniting with native platform tool.
Feautures
- tiny and clean way :rocket:.
- Native Implementation :chart_with_upwards_trend: .
- Easy To Use :heart_eyes: ( only have one method ) .
- No
ios
Support :hankey: ( may be add in future ) .
Result
Installation
installing with yarn :
yarn add react-native-voice-recognizer
or alternativly with npm :
npm i react-native-voice-recognizer
Note : if you are using RN@>=0.60 you dont need any more enjoy RN auto-linking with npx react-native run-android
but for RN@<0.60 you need to link
with react-native link
or linking manually .
manully linking will add soon here.
Usage
first import
import VoiceRecognizer from 'react-native-voice-recognizer';
then use with then/catch ES6 syntax :
//settings are required
const locale = 'en-US'; //or for example : 'fa-IR'
const promptLabel = 'Say Something...';
//request for recognizing
VoiceRecognizer.requestVoice(locale, promptLabel)
.then(result => {
//do anything with result and enjoy
})
.catch(e => {
//your device does not support voice recognition
});
And Enjoy. :heart_eyes: Or use with async/await ES2017 feature :
const startListennig = async () => {
//settings are requires
const locale = 'en-US'; //or for example :'fa-IR'
const promptLabel = 'Say Something...'; //or anything you want
try {
const result = await VoiceRecognizer.requestVoice(locale, promptLabel);
//do anything with result and enjoy
} catch (error) {
//your device does not support voice recognition
}
};
Api
soon add here
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Licence
MIT
maked with :heart: for developers.