Rhino Speech-to-Intent
Android Quick Start

Platforms

• Android (5.0+)

Requirements

• Picovoice Account and AccessKey
• Android Studio
• Android device with USB debugging enabled or Android simulator

Picovoice Account & AccessKey

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

Quick Start

Setup

1. Install Android Studio.

2. Include mavenCentral() repository in the top-level build.gradle. Then add the following to the app's build.gradle:

dependencies {
    // ...
    implementation 'ai.picovoice:rhino-android:${LATEST_VERSION}' // replace with latest version
}

3. Add the following to the app's AndroidManifest.xml file to enable recording with an Android device's microphone:

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

Usage

Use the RhinoManager Builder to create an instance of RhinoManager:

import ai.picovoice.rhino.*;

RhinoManagerCallback inferenceCallback = new RhinoManagerCallback() {
  @Override
  public void invoke(RhinoInference inference) {
    if (inference.getIsUnderstood()) {
      String intent = inference.getIntent();
      Map<String, String> slots = inference.getSlots();
      // take action based on inferred intent and slot values
    } else {
      // handle unsupported commands
    }
  }
};

RhinoMananger rhinoManager = new RhinoManager.Builder()
  .setAccessKey("${ACCESS_KEY}")
  .setContextPath("${CONTEXT_FILE_PATH}")
  .build(context, inferenceCallback);

Start audio capture and the Speech-to-Intent engine:

rhinoManager.process();

Once an inference has been made, the RhinoManagerCallback will be invoked and audio capture will stop automatically.

Free resources used by RhinoManager:

rhinoManager.delete();

Custom Contexts

Create custom contexts using the Picovoice Console. Download the custom context file (.rhn) and add it to the ${ANDROID_APP}/src/main/assets directory of your Android project. Create an instance of RhinoManager using the .setContextPath builder method and the context file path (relative to the assets directory).

Alternatively, if the context file is deployed to the device with a different method, the absolute path to the file on device can be used.

Non-English Languages

Use the corresponding model file (.pv) to detect non-English contexts. The model files for all supported languages are available on the Rhino Speech-to-Intent GitHub repository.

Pass in the model path (relative to the assets directory) using the setModelPath builder method to change the inference language:

RhinoManager rhinoManager = new RhinoManager.Builder()
  .setAccessKey("${ACCESS_KEY}")
  .setContextPath("${CONTEXT_FILE_PATH}")
  .setModelPath("${MODEL_FILE_PATH}")
  .build(context, inferenceCallback);

Alternatively, if the model file is deployed to the device with a different method, the absolute path to the file on device can be used.

Demo

For the Rhino Speech-to-Intent Android SDK, we offer demo applications that demonstrate how to use the Speech-to-Intent engine on real-time audio streams (i.e. microphone input).

Setup

Clone the Rhino Speech-to-Intent repository from GitHub using HTTPS:

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

Usage

1. Open the Android Activity demo using Android Studio.
2. Go to Build > Select Build Variant... and select the language you would like to run the demo in (e.g. enDebug -> English, itRelease -> Italian)
3. Copy your AccessKey from Picovoice Console into the ACCESS_KEY variable in MainActivity.java.
4. Run the application using a connected Android device or using an Android simulator.

Resources