androidPicovoice Platform — Android Quick Start

Platforms

  • Android (4.4+)

Requirements

Picovoice Account & AccessKey

  1. Login or Signup for a free account on the Picovoice Console.
  2. Once logged in, go to the AccessKey tab to create one or use an existing AccessKey. Be 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:picovoice-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 PicovoiceManager Builder to create an instance of PicovoiceManager using a Porcupine keyword file (.ppn), and a Rhino context file (.rhn):

import ai.picovoice.picovoice.*;
PicovoiceManager picovoiceManager = new PicovoiceManager.Builder()
.setAccessKey("${ACCESS_KEY}")
.setKeywordPath("${KEYWORD_FILE_PATH}")
.setWakeWordCallback(wakeWordCallback)
.setContextPath("${CONTEXT_FILE_PATH}")
.setInferenceCallback(inferenceCallback)
.build(context);
PicovoiceWakeWordCallback wakeWordcallback = new PicovoiceWakeWordCallback() {
@Override
public void invoke() {
// keyword detected
}
}
PicovoiceInferenceCallback inferenceCallback = new PicovoiceInferenceCallback() {
@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 Picovoice Platform:

picovoiceManager.start();

Stop with:

picovoiceManager.stop();

Free resources used by picovoiceManager:

picovoiceManager.delete();

Custom Wake Words & Contexts

Create custom keyword using the Picovoice Console. Download the custom models (.ppn and .rhn) and create an instance of PicovoiceManager using the setKeywordPath and setContextPath builder methods.

Non-English Languages

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

Pass in the model files using setPorcupineModelPath and setRhinoModelPath builder methods to change the language:

PicovoiceManager picovoiceManager = new PicovoiceManager.Builder()
.setAccessKey("${ACCESS_KEY}")
.setKeywordPath("${KEYWORD_FILE_PATH}")
.setWakeWordCallback(wakeWordCallback)
.setContextPath("${CONTEXT_FILE_PATH}")
.setInferenceCallback(inferenceCallback)
.setPorcupineModelPath("${PORCUPINE_MODEL_FILE_PATH}")
.setRhinoModelPath("${RHINO_MODEL_FILE_PATH}")
.build(context);

Demo

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

Setup

Clone the Picovoice repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/picovoice.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.

The demo detects the chosen keyword only when the application is in focus. To run the demo in the background head over to our Github repository.

Resources

Packages

API

GitHub


Issue with this doc? Please let us know.