Porcupine Wake Word
Java Quick Start
- Linux (x86_64)
- macOS (x86_64, arm64)
- Windows (x86_64)
- NVIDIA Jetson Nano
- Raspberry Pi (2, 3, 4)
- Picovoice Account and AccessKey
- Java 11+
Picovoice Account & AccessKey
Signup or Login to Picovoice Console to get your
Make sure to keep your
Install JDK 11+ .
Install the Java binding from the Maven Central Repository at:
Create an instance of Porcupine that detects the included built-in wake words
Pass in frames of audio to the
Release resources explicitly when done with Porcupine:
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:
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:
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.
- Clone the Porcupine repository from GitHub:
- Build the Porcupine Java demo using
-h flag to see the usage options for the demos:
Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword
For more information on our Porcupine demos for Java, head over to our GitHub repository .