Skip to content

Latest commit

 

History

History
149 lines (119 loc) · 4.7 KB

README.md

File metadata and controls

149 lines (119 loc) · 4.7 KB
Raw

react-native-android-voice

DUB npm version

react-native-android-voice is a speech-to-text library for React Native for the Android Platform.

##Any Feedback and Ideas are welcome! please use the Issues section above

Documentation

Install

npm install --save react-native-android-voice

Usage

Linking the Library

Add it to your android project

  • In android/setting.gradle
...
include ':VoiceModule', ':app'
project(':VoiceModule').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-android-voice')
  • In android/app/build.gradle
...
dependencies {
    ...
    compile project(':VoiceModule')
}
  • Register Module (in MainActivity.java)
import com.wmjmc.reactspeech.VoicePackage;  // <--- import

public class MainActivity extends ReactActivity {
...
    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
        new MainReactPackage(),
        new VoicePackage()); // <--- added here
    }
}

Example / Usage v0.1.1

import SpeechAndroid from 'react-native-android-voice';

...
async _someFunction(){
    var spokenText = await SpeechAndroid.startSpeech();
    ...
}
...

Example v0.2.0 - Final tests being made before release

  • Error Handling
  • Custom Prompt
  • Several Locales to choose from

##Example of what's to come

...
async _buttonClick(){
    try{
        //More Locales will be available upon release.
        var spokenText = await SpeechAndroid.startSpeech("Speak yo", SpeechAndroid.GERMAN);
        ToastAndroid.show(spokenText , ToastAndroid.LONG);
    }catch(error){
        switch(error){
            case SpeechAndroid.E_VOICE_CANCELLED:
                ToastAndroid.show("Voice Recognizer cancelled" , ToastAndroid.LONG);
                break;
            case SpeechAndroid.E_NO_MATCH:
                ToastAndroid.show("No match for what you said" , ToastAndroid.LONG);
                break;
            case SpeechAndroid.E_SERVER_ERROR:
                ToastAndroid.show("Google Server Error" , ToastAndroid.LONG);
                break;
            /*And more errors that will be documented on Docs upon release*/
        }
    }
}
...

This will automatically start recognizing and adjusting for the German Language. On release I'll update these docs with every single Locale available.

Methods v0.1.1

startSpeech()

Initializes the voice recognition activity and returns what you spoke in text.

Arguments

  • none ............ for now

TODO

  • Change Package/Module Name: from SpeechPackage to VoicePackage
  • Update ReadMe
  • Develop customization options for the module such as Custom text for the native activity and Locales

License

The MIT License (MIT)

Copyright © 2015 João Cunha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.