Porcupine Wake Word
C Quick Start
Platforms
- Linux (x86_64)
- macOS (x86_64, arm64)
- Windows (x86_64)
- BeagleBone
- NVIDIA Jetson Nano
- Raspberry Pi (Zero, 2, 3, 4)
Requirements
Picovoice Account & AccessKey
Signup or Login to Picovoice Console to get your AccessKey
.
Make sure to keep your AccessKey
secret.
Setup
- Clone the repository:
Usage
- Include the public header files (
picovoice.h
andpv_porcupine.h
) . - Link the project to an appropriate precompiled library for the target platform and load it.
- Download a language model .
- Download a keyword file based on the desired language and the target platform.
- Construct the Porcupine object:
- Pass in frames of audio to the
pv_porcupine_process
function:
- Release resources explicitly when done with Porcupine:
Custom Keywords
Create custom keywords using the Picovoice Console . Download the custom wake word
file (.ppn
) and create an instance of Porcupine using the custom keyword model.
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 .
Demo
For the Porcupine 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
- Clone the repository:
- Build the microphone demo:
Usage
To see the usage options for the demo:
Ensure you have a working microphone connected to your system and run the following command to detect porcupine
:
For more information on our Porcupine demos for C, head over to our GitHub repository .