Porcupine Wake Word
Java Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• BeagleBone
• NVIDIA Jetson Nano
• Raspberry Pi (2, 3, 4)

Requirements

• Picovoice Account and AccessKey
• Java 11+

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:porcupine-java:${version}

Usage

Create an instance of Porcupine that detects the included built-in wake words porcupine and bumblebee:

import ai.picovoice.porcupine.*;

Porcupine porcupine = new Porcupine.Builder()
                        .setAccessKey("${ACCESS_KEY}")
                        .setBuiltInKeywords(new BuiltInKeyword[]{BuiltInKeyword.PICOVOICE, BuiltInKeyword.BUMBLEBEE})
                        .build();

Pass in frames of audio to the .process function:

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

while(true) {
    int keywordIndex = porcupine.process(getNextAudioFrame());
    if(keywordIndex == 0) {
      // detected `porcupine`
    } else if (keywordIndex == 1) {
      // detected `bumblebee`
    }
}

Release resources explicitly when done with Porcupine:

porcupine.delete();

Custom Keywords

Create custom keywords using the Picovoice Console . Download the custom wake word file (.ppn) and create an instance of Porcupine using the setKeywordPaths build method:

Porcupine porcupine = new Porcupine.Builder()
                        .setAccessKey("${ACCESS_KEY}")
                        .setKeywordPaths(new String[]{"${KEYWORD_FILE_PATH}"})
                        .build();

Non-English Languages

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

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

Porcupine porcupine = new Porcupine.Builder()
                        .setAccessKey("${ACCESS_KEY}")
                        .setKeywordPaths(new String[]{"${KEYWORD_FILE_PATH}"})
                        .setModelPath("${MODEL_FILE_PATH}")
                        .build();

Demo

For the Porcupine Java SDK, we offer demo applications that demonstrate how to use the Wake Word engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

1. Clone the Porcupine repository from GitHub:

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

2. Build the Porcupine Java demo using Gradle:

cd porcupine/demo/java
./gradlew build

Usage

Use the -h flag to see the usage options for the demos:

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

Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword porcupine:

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

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

Resources