androidRhino - Android Quick Start

Platforms

  • Android (4.4+)

Requirements

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
}
  1. 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.*;
RhinoMananger rhinoManager = new RhinoManager.Builder()
.setAccessKey("${ACCESS_KEY}")
.setContextPath("${CONTEXT_FILE_PATH}")
.build(context, inferenceCallback);
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
}
}
}

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 create an instance of RhinoManager using the .setContextPath build method.

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 GitHub repository.

Pass in the model file using the setModelPath builder method to change the detection language:

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

Demo

For the Rhino 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 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. Copy your AccessKey from Picovoice Console into the ACCESS_KEY variable in MainActivity.java.
  3. Run the application using a connected Android device or using an Android simulator.

Resources

Packages

API

GitHub


Issue with this doc? Please let us know.