Picovoice Platform — React Native Quick Start

Platforms

Android 4.4+ (API 19+)
iOS 9.0+

Requirements

Picovoice Account and AccessKey
React Native 0.62.2+

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

Setup the React Native environment.
Install the npm packages:

npm install @picovoice/react-native-voice-processor @picovoice/picovoice-react-native @picovoice/porcupine-react-native @picovoice/rhino-react-native

Enable the proper permission for recording with the hardware's microphone on both iOS and Android:

iOS

Open your Info.plist and add the following line:

<key>NSMicrophoneUsageDescription</key>
<string>[Permission explanation]</string>

Android

Open your AndroidManifest.xml and add the following line:

<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />

Usage

Request audio recording permissions from the user:

const recordAudioRequest = async () => {
  if (Platform.OS == 'android') {
    // Android requires an explicit call to ask for permission
    const granted = await PermissionsAndroid.request(
      PermissionsAndroid.PERMISSIONS.RECORD_AUDIO,
      {
        title: 'Microphone Permission',
        message: '[Permission explanation]',
        buttonNeutral: 'Ask Me Later',
        buttonNegative: 'Cancel',
        buttonPositive: 'OK',
      }
    );
    return (granted === PermissionsAndroid.RESULTS.GRANTED)
  } else {
    // iOS will automatically ask for permission
    return true;
  }
};

const hasPermission = await recordAudioRequest();

Create an instance of PicovoiceManager using a Porcupine keyword file (.ppn), and a Rhino context file (.rhn):

import {PicovoiceManager} from '@picovoice/picovoice-react-native';

let wakeWordCallback = () => {
  // wake word detected
};

let inferenceCallback = (inference) => {
  if (inference.isUnderstood) {
    let intent = inference.intent;
    let slots = inference.slots;
    // take action based on inferred intent and slot values
  } else {
    // handle unsupported commands
  }
};

let picovoiceManager = await PicovoiceManager.create(
  "${ACCESS_KEY}",
  "${KEYWORD_FILE_PATH}",
  wakeWordCallback,
  "${CONTEXT_FILE_PATH}",
  inferenceCallback
);

Start audio capture and processing with:

await picovoiceManager.start();

Stop with:

await picovoiceManager.stop();

Free resources used by PicovoiceManager:

picovoiceManager.delete();

To use your own audio processing pipeline, check out the Low-Level Picovoice API.

Custom Wake Words & Contexts

Create custom keywords and contexts using the Picovoice Console. Download the custom models (.ppn and .rhn) add them to the application and create an instance of PicovoiceManager using the .create constructor.

Android custom models must be added to ./android/app/src/main/assets/.
iOS custom models can be added anywhere under ./ios, but they must be included as a bundled resource in XCode by right-clicking on the Navigation tab, and clicking Add Files To ....

Non-English Languages

Use the corresponding model files (.pv) to detect non-English wake words. The model files for all supported languages are available on the Porcupine GitHub repository and the Rhino GitHub repository.

Pass in the model file using the porcupineModelPath and rhinoModelPath arguments:

let picovoiceManager = await PicovoiceManager.create(
  "${ACCESS_KEY}",
  "${KEYWORD_FILE_PATH}",
  wakeWordCallback,
  "${CONTEXT_FILE_PATH}",
  inferenceCallback
  processErrorCallback,
  0.5,
  0.5,
  "${PORCUPINE_MODEL_FILE_PATH}"
  "${RHINO_MODEL_FILE_PATH}"
);

Demo

For the Picovoice React Native SDK, there is a React Native demo project available on the Picovoice GitHub repository.

Setup

Clone the Picovoice repository from GitHub:

git clone --recurse-submodules https://github.com/Picovoice/picovoice.git

Usage

Install dependencies and setup environment:

cd picovoice/demo/react-native

npm run android-install
# or
npm run ios-install

Connect a mobile device or launch a simulator and run:

npm run android-run
# or
npm run ios-run

For more information on our Picovoice demos for React Native, head over to our GitHub repository.

Picovoice Platform — React Native Quick Start

Platforms

Requirements

Picovoice Account & AccessKey

Quick Start

Setup

Usage

Custom Wake Words & Contexts

Non-English Languages

Demo

Setup

Usage

Resources

Packages

API

GitHub

Benchmark

Further Reading

Videos