![CircleCI branch][circle-ci-badge]
[![npm][npm]][npm-url]

React Native Voice

A speech-to-text library for React Native.

alt="chat on Discord">

``sh
yarn add @bitblit/ratchet-react-native-voice

or

npm i @bitblit/ratchet-react-native-voice --save
`

Link the iOS package

`sh
npx pod-install
`

Table of contents

- Linking
- Manually Link Android
- Manually Link iOS
- Prebuild Plugin
- Usage
- Example
- API
- Events
- Permissions
- Android
- iOS
- Contributors

Linking

Manually or automatically link the NativeModule

`sh
react-native link @bitblit/ratchet-react-native-voice
`

$3

- In android/setting.gradle

`gradle
...
include ':@bitblit_ratchet-react-native-voice', ':app'
project(':@bitblit_ratchet-react-native-voice').projectDir = new File(rootProject.projectDir, '../node_modules/@bitblit/ratchet-react-native-voice/android')
`

- In android/app/build.gradle

`gradle
...
dependencies {
...
compile project(':@bitblit_ratchet-react-native-voice')
}
`

- In MainApplication.java

`java

import android.app.Application;
import com.facebook.react.ReactApplication;
import com.facebook.react.ReactPackage;
...
import com.erigir.voice.VoicePackage; // <------ Add this!
...

public class MainActivity extends Activity implements ReactApplication {
...
@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage(),
new VoicePackage() // <------ Add this!
);
}
}
`

$3

- Drag the Voice.xcodeproj from the @bitblit/ratchet-react-native-voice/ios folder to the Libraries group on Xcode in your poject. Manual linking

- Click on your main project file (the one that represents the .xcodeproj) select Build Phases and drag the static library, lib.Voice.a, from the Libraries/Voice.xcodeproj/Products folder to Link Binary With Libraries

Prebuild Plugin

> This package cannot be used in the "Expo Go" app because it requires custom native code.

After installing this npm package, add the config plugin to the plugins array of your app.json or app.config.js:

`json
{
"expo": {
"plugins": ["@bitblit/ratchet-react-native-voice"]
}
}
`

Next, rebuild your app as described in the "Adding custom native code" guide.

$3

The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and prebuild) the native app. If no extra properties are added, defaults will be used.

- speechRecognition (_string | false_): Sets the message for the NSSpeechRecognitionUsageDescription key in the Info.plist message. When undefined, a default permission message will be used. When false, the permission will be skipped.
- microphone (_string | false_): Sets the message for the NSMicrophoneUsageDescription key in the Info.plist. When undefined, a default permission message will be used. When false, the android.permission.RECORD_AUDIO will not be added to the AndroidManifest.xml and the iOS permission will be skipped.

$3

`json
{
"plugins": [
[
"@bitblit/ratchet-react-native-voice",
{
"microphonePermission": "CUSTOM: Allow $(PRODUCT_NAME) to access the microphone",
"speechRecognitionPermission": "CUSTOM: Allow $(PRODUCT_NAME) to securely recognize user speech"
}
]
]
}
`

Usage

Full example for Android and iOS.

$3

`javascript
import Voice from '@bitblit/ratchet-react-native-voice';
import React, {Component} from 'react';

class VoiceTest extends Component {
constructor(props) {
Voice.onSpeechStart = this.onSpeechStartHandler.bind(this);
Voice.onSpeechEnd = this.onSpeechEndHandler.bind(this);
Voice.onSpeechResults = this.onSpeechResultsHandler.bind(this);
}
onStartButtonPress(e){
Voice.start('en-US');
}
...
}
`

API

Static access to the Voice API.

All methods _now_ return a new Promise for async/await compatibility.

| Method Name | Description | Platform |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| Voice.isAvailable() | Checks whether a speech recognition service is available on the system. | Android, iOS |
| Voice.start(locale) | Starts listening for speech for a specific locale. Returns null if no error occurs. | Android, iOS |
| Voice.stop() | Stops listening for speech. Returns null if no error occurs. | Android, iOS |
| Voice.cancel() | Cancels the speech recognition. Returns null if no error occurs. | Android, iOS |
| Voice.destroy() | Destroys the current SpeechRecognizer instance. Returns null if no error occurs. | Android, iOS |
| Voice.removeAllListeners() | Cleans/nullifies overridden Voice static methods. | Android, iOS |
| Voice.isRecognizing() | Return if the SpeechRecognizer is recognizing. | Android, iOS |
| Voice.getSpeechRecognitionServices() | Returns a list of the speech recognition engines available on the device. (Example: ['com.google.android.googlequicksearchbox'] if Google is the only one available.) | Android |

Events

Callbacks that are invoked when a native event emitted.

| Event Name | Description | Event | Platform |
| ----------------------------------- | ------------------------------------------------------ | ----------------------------------------------- | ------------ |
| Voice.onSpeechStart(event) | Invoked when .start() is called without error. | { error: false } | Android, iOS |
| Voice.onSpeechRecognized(event) | Invoked when speech is recognized. | { error: false } | Android, iOS |
| Voice.onSpeechEnd(event) | Invoked when SpeechRecognizer stops recognition. | { error: false } | Android, iOS |
| Voice.onSpeechError(event) | Invoked when an error occurs. | { error: Description of error as string } | Android, iOS |
| Voice.onSpeechResults(event) | Invoked when SpeechRecognizer is finished recognizing. | { value: [..., 'Speech recognized'] } | Android, iOS |
| Voice.onSpeechPartialResults(event) | Invoked when any results are computed. | { value: [..., 'Partial speech recognized'] } | Android, iOS |
| Voice.onSpeechVolumeChanged(event) | Invoked when pitch that is recognized changed. | { value: pitch in dB } | Android |

Permissions

Arguably the most important part.

$3

While the included VoiceTest app works without explicit permissions checks and requests, it may be necessary to add a permission request for RECORD_AUDIO for some configurations.
Since Android M (6.0), user need to grant permission at runtime (and not during app installation).
By default, calling the startSpeech method will invoke RECORD AUDIO permission popup to the user. This can be disabled by passing REQUEST_PERMISSIONS_AUTO: true in the options argument.

If you're running an ejected expo/expokit app, you may run into issues with permissions on Android and get the following error host.exp.exponent.MainActivity cannot be cast to com.facebook.react.ReactActivity startSpeech. This can be resolved by prompting for permssion using the expo-permission package before starting recognition.

`js
import { Permissions } from "expo";
async componentDidMount() {
const { status, expires, permissions } = await Permissions.askAsync(
Permissions.AUDIO_RECORDING
);
if (status !== "granted") {
//Permissions not granted. Don't show the start recording button because it will cause problems if it's pressed.
this.setState({showRecordButton: false});
} else {
this.setState({showRecordButton: true});
}
}
`

Notes on Android

Even after all the permissions are correct in Android, there is one last thing to make sure this libray is working fine on Android. Please make sure the device has Google Speech Recognizing Engine such as com.google.android.googlequicksearchbox by calling Voice.getSpeechRecognitionServices(). Since Android phones can be configured with so many options, even if a device has googlequicksearchbox engine, it could be configured to use other services. You can check which serivce is used for Voice Assistive App in following steps for most Android phones:

Settings > App Management > Default App > Assistive App and Voice Input > Assistive App

Above flow can vary depending on the Android models and manufactures. For Huawei phones, there might be a chance that the device cannot install Google Services.

How can I get com.google.android.googlequicksearchbox in the device?

Please ask users to install Google Search App.

$3

Need to include permissions for NSMicrophoneUsageDescription and NSSpeechRecognitionUsageDescription inside Info.plist for iOS. See the included VoiceTest for how to handle these cases.

`xml

...
NSMicrophoneUsageDescription
Description of why you require the use of the microphone
NSSpeechRecognitionUsageDescription
Description of why you require the use of the speech recognition
...

``

Please see the documentation provided by ReactNative for this: PermissionsAndroid

[npm]: https://img.shields.io/npm/v/@bitblit/ratchet-react-native-voice.svg?style=flat-square
[npm-url]: https://npmjs.com/package/@bitblit/ratchet-react-native-voice
[circle-ci-badge]: https://img.shields.io/circleci/project/github/react-native-voice/voice/master.svg?style=flat-square

Contributors

- @asafron
- @BrendanFDMoore
- @brudny
- @chitezh
- @ifsnow
- @jamsch
- @misino
- @Noitidart
- @ohtangza & @hayanmind
- @rudiedev6
- @tdonia
- @wenkesj
- @bitblit