Porcupine Wake Word
Unity Quick Start
- Linux (x86_64)
- macOS (x86_64, arm64)
- Windows (x86_64)
- Android (5.0+, API 21+) (ARM only)
- iOS (11.0+)
- Picovoice Account & AccessKey
- Unity 2017.4+ (Unity 2021.2+ for macOS arm64)
- Unity Build Support modules for desired platforms
Picovoice Account & AccessKey
Signup or Login to Picovoice Console to get your
Make sure to keep your
- Download and install Unity .
- Download and import the latest Porcupine Unity package .
NOTE: For running Porcupine on macOS arm64, use the
porcupine-*-Apple-silicon.unitypackage version with Unity 2021.2+.
Create an instance of
PorcupineManager that detects the included built-in
bumblebee using the
Start audio capture and wake word detection with:
Release resources acquired by
Create custom keywords using the Picovoice Console .
Download the custom wake word file (
.ppn) and create an instance of
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
modelPath input argument to change the detection language:
For the Porcupine Unity SDK, we offer demo applications that demonstrate how to use the Wake Word engine on real-time audio streams (i.e. microphone input).
Download and import the latest Porcupine Unity package .
- Open the Porcupine Demo Scene (
AccessKeyfrom Picovoice Console into the
ACCESS_KEYvariable in PorcupineDemo.cs
- Play the scene in the editor or go to
File > Build Settingsand click the
Build and Runbutton to compile and run the scene for the selected platform.