Cheetah Speech-to-Text
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:cheetah-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" />

Adding a Cheetah Model File

Add the Cheetah model file to your Android application:

1. Create a custom model using the Picovoice Console or use the default model .
2. Add the model as a bundled resource by placing it under the ${ANDROID_APP}/src/main/assets directory of your Android project.

Usage

Create an instance of the engine with the Cheetah Builder by passing in your AccessKey, model file and the Android app context:

import ai.picovoice.cheetah.*;

final String accessKey = "${ACCESS_KEY}"; // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
final String modelPath = "${MODEL_PATH}"; // path relative to the assets folder or absolute path to file on device 

try {
    Cheetah cheetah = new Cheetah.Builder()
      .setAccessKey(accessKey)
      .setModelPath(modelPath)
      .build(appContext);
} catch (CheetahException ex) { }

Transcribe real-time audio:

short[] getNextAudioFrame() {
    // .. get audioFrame
    return audioFrame;
}

String transcript = "";

while (true) {
    try {
        short[] audioFrame = getNextAudioFrame();
        CheetahTranscript partialResult = cheetah.process(audioFrame);
        transcript += partialResult.getTranscript();
    
        if (partialResult.getIsEndpoint()) {
            CheetahTranscript finalResult = cheetah.flush();
            transcript += finalResult.getTranscript();
        }
    } catch (CheetahException ex) { }
}

When done, release resources explicitly:

cheetah.delete();

Demo

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

Setup

Clone the Cheetah repository from GitHub using HTTPS:

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

Usage

1. Open the Android 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