Porcupine — .NET Quick Start

Platforms

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

Requirements

• Picovoice Account & AccessKey

.NET Framework 4.6.1+ / .NET Standard 2.0+ / .NET Core 3.1+:

• Windows (x86_64)

.NET Core 2.0+ / .NET Core 3.1+:

• Linux (x86_64)
• macOS (x86_64)

.NET Core 3.1+:

• BeagleBone
• NVIDIA Jetson Nano
• Raspberry Pi (2, 3, 4)

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 .NET.

2. Install the Porcupine NuGet package in Visual Studio or using the .NET CLI:

dotnet add package Porcupine

Usage

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

using Pv;

Porcupine porcupine = Porcupine.FromBuiltInKeywords(
        "${ACCESS_KEY}",
        new List<BuiltInKeyword> {BuiltInKeyword.PORCUPINE, BuiltInKeyword.BUMBLEBEE});

Pass in frames of audio to the .Process function:

short[] GetNextAudioFrame()
{
    // ...
}

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

Custom Keywords

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

Porcupine porcupine = Porcupine.FromKeywordPaths(
        "${ACCESS_KEY}",
        new List<string> {"${KEYWORD_FILE_PATH}"});

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 input argument to change the detection language:

Porcupine porcupine = Porcupine.FromKeywordPaths(
        "${ACCESS_KEY}",
        new List<string> {"${KEYWORD_FILE_PATH}"},
        modelPath: "${MODEL_FILE_PATH}");

Demo

For the Porcupine .NET 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 demo:

cd porcupine/demo/dotnet/PorcupineDemo
dotnet build -c MicDemo.Release

Usage

Use the --help flag to see the usage options for the demo:

dotnet run -c MicDemo.Release -- --help

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

dotnet run -c MicDemo.Release -- --access_key ${ACCESS_KEY} --keywords porcupine

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

Resources

Packages

• Porcupine on NuGet

API

• Porcupine .NET API Docs

GitHub

• Porcupine .NET SDK on GitHub
• Porcupine .NET Demos on GitHub

Benchmark

• Wake Word Benchmark

Further Reading

• Talking Chess: Adding Offline, Cross-Platform Voice Controls to Chess in .NET Core
• From GUI to VUI: Voice-Enabling a Cross-Platform .NET Desktop Application
• How We Added Raspberry Pi Support to Our .NET SDK

Videos

• Offline Wake Word Engine Running in .NET Core on Raspberry Pi
• Build a Voice-Controlled, Cross-Platform .NET Desktop Application
• Add Offline Voice Controls to a Cross-Platform .NET GUI