Porcupine Wake Word
Go 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 & AccessKey
- Go 1.16+
- Windows only: a gcc compiler like Mingw in $PATH
Picovoice Account & AccessKey
Signup or Login to Picovoice Console to get your AccessKey
.
Make sure to keep your AccessKey
secret.
Quick Start
Setup
Download and install Go language .
Install the Porcupine Go Package using the Go CLI:
Usage
Create an instance of Porcupine that detects the included built-in wake words porcupine
and bumblebee
using the Porcupine
struct:
Pass in frames of audio to the .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 KeywordPaths
parameter:
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 ModelPath
parameter to change the detection language:
Demo
For the Porcupine Go 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 Porcupine GitHub Repository :
Usage
Use the -h
flag 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 the built-in keyword porcupine
:
For more information on our Porcupine demos for Go, head over to our GitHub repository .