javaCheetah - Java Quick Start

Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • NVIDIA Jetson Nano
  • Raspberry Pi (3, 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 JDK 11+.

  2. Install the Java binding from the Maven Central Repository at:

ai.picovoice:cheetah-java:${version}

Usage

Create an instance of the engine with the Cheetah Builder class:

import ai.picovoice.cheetah.*;
final String accessKey = "..."; // AccessKey provided by Picovoice Console (https://console.picovoice.ai/)
try {
Cheetah cheetah = new Cheetah.Builder().setAccessKey(accessKey).build();
} catch (CheetahException ex) { }

Transcribe audio:

short[] getNextAudioFrame() {
// .. get audioFrame
return audioFrame;
}
String transcript = "";
while true {
CheetahTranscript transcriptObj = cheetah.process(getNextAudioFrame());
transcript += transcriptObj.getTranscript();
if (transcriptObj.getIsEndpoint()) {
CheetahTranscript finalTranscriptObj = cheetah.flush();
transcript += finalTranscriptObj.getTranscript();
}
}

When done resources have to be released explicitly:

cheetah.delete();

Demo

For the Cheetah Java 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

  1. Clone the Cheetah repository from GitHub using HTTPS:
git clone --recurse-submodules https://github.com/Picovoice/cheetah.git
  1. Build the Cheetah Java demo using Gradle:
cd cheetah/demo/java
./gradlew build

Usage

To see the usage options for the demos, use the -h flag:

java -jar build/libs/cheetah-mic-demo.jar -h

Ensure you have a working microphone connected to your system and run the following command to perform live speech-to-text:

java -jar build/libs/cheetah-mic-demo.jar -a ${ACCESS_KEY}

For more information on our Cheetah demos for Java, head over to our GitHub repository.

Resources

Packages

API

GitHub

Benchmark


Issue with this doc? Please let us know.