A Speech-to-text Library for React Native

A Speech-to-text Library for React Native

React Native Voice A speech-to-text library for React Native. React Native Voice Recognition library for iOS and Android (Online and Offline Support)

React Native Voice

A speech-to-text library for React Native.

chat on Discord

yarn add @react-native-voice/voice

# or 

npm i @react-native-voice/voice --save

Link the iOS package

npx pod-install


Manually or automatically link the NativeModule

react-native link @react-native-voice/voice
  • In android/setting.gradle
include ':@react-native-voice_voice', ':app'
project(':@react-native-voice_voice').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-voice/voice/android')
  • In android/app/build.gradle
dependencies {
    compile project(':@react-native-voice_voice')
  • In MainApplication.java
import android.app.Application;
import com.facebook.react.ReactApplication;
import com.facebook.react.ReactPackage;
import com.wenkesj.voice.VoicePackage; // <------ Add this!

public class MainActivity extends Activity implements ReactApplication {
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
        new MainReactPackage(),
        new VoicePackage() // <------ Add this!
  • Drag the Voice.xcodeproj from the @react-native-voice/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


Full example for Android and iOS.


import Voice from '@react-native-voice/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);


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


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


Arguably the most important part.


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.

import { Permissions } from "expo";
async componentDidMount() {
    const { status, expires, permissions } = await Permissions.askAsync(
    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.


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

  <string>Description of why you require the use of the microphone</string>
  <string>Description of why you require the use of the speech recognition</string>

Please see the documentation provided by ReactNative for this: PermissionsAndroid


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

Download Details:

Author: react-native-voice

Source Code: https://github.com/react-native-voice/voice

react-native react mobile-apps

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

How native is React Native? | React Native vs Native App Development

Article covers: How native is react native?, React Native vs (Ionic, Cordova), Similarities and difference between React Native and Native App Development.

React Native Mobile App Development

Skenix is providing React Native Development Services with qualified React Native App Developers. Get the best React Native App Development Services.

How React Native Is Shaping Mobile App Development

Are you a mobile app developer looking for more efficient tools for your projects? Mobile app development is getting tougher and tougher as the market continues to grow. As a developer, you need to develop Apps which meet the demands of your users. To achieve this, adopt the right tools, like the React Native development framework.

Top React Native Mobile App Development Companies in USA

Looking for top React Native mobile app development company in USA for Startups & Enterprise? Find out the top list of React Native mobile app development company in USA.

Which is the best React Native app development company in New York?

Hire top react native app development company in New York to build and develop custom react native mobile apps for Android & iOS with the latest features.