Picovoice WordmarkPicovoice Console
Introduction
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSNodejsPythonRaspberry PiReact NativeRustWebWindows
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
SummaryPicovoice LeopardAmazon TranscribeAzure Speech-to-TextGoogle ASRGoogle ASR (Enhanced)IBM Watson Speech-to-Text
FAQ
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
FAQ
Introduction
AndroidCiOSLinuxmacOSPythonWebWindows
AndroidCiOSPythonWeb
SummaryOctopus Speech-to-IndexGoogle Speech-to-TextMozilla DeepSpeech
FAQ
Introduction
AndroidAngularArduinoBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaMicrocontrollerNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPorcupineSnowboyPocketSphinx
Wake Word TipsFAQ
Introduction
AndroidAngularBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonlinuxmacOSNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPicovoice RhinoGoogle DialogflowAmazon LexIBM WatsonMicrosoft LUIS
Expression SyntaxFAQ
Introduction
AndroidBeagleboneCiOSNvidia JetsonLinuxmacOSPythonRaspberry PiRustWebWindows
AndroidCiOSPythonRustWeb
SummaryPicovoice CobraWebRTC VAD
FAQ
Introduction
AndroidAngularArduinoBeagleBoneC.NETFlutterlink to GoiOSJavaNvidia JetsonMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustUnityVueWeb
AndroidAngularCMicrocontroller.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
Picovoice SDK - FAQ
IntroductionSTM32F407G-DISC1 (Arm Cortex-M4)STM32F411E-DISCO (Arm Cortex-M4)STM32F769I-DISCO (Arm Cortex-M7)IMXRT1050-EVKB (Arm Cortex-M7)
FAQGlossary

Picovoice Platform
Unity Quick Start


Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • Android 4.4+ (API 19+) (ARM only)
  • iOS 9.0+

Requirements

  • 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 AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

  1. Download and install Unity.
  2. Download and import the latest Picovoice Unity package.

NOTE: For running Picovoice on macOS arm64, use the picovoice-*-Apple-silicon.unitypackage version with Unity 2021.2+.

Usage

Create an instance of PicovoiceManager using a Porcupine keyword file (.ppn), and a Rhino context file (.rhn):

using Pv.Unity;
void wakeWordCallback()
{
// wake word detected
}
void inferenceCallback(Inference inference)
{
if(inference.IsUnderstood)
{
string intent = inference.Intent;
Dictionary<string, string> slots = inference.Slots;
// take action based on inferred intent and slot values
}
else
{
// handle unsupported commands
}
}
PicovoiceManager picovoiceManager = PicovoiceManager.Create(
"${ACCESS_KEY}",
"${KEYWORD_FILE_PATH}", // path is relative to the `StreamingAssets` folder
wakeWordCallback,
"${CONTEXT_FILE_PATH}", // path is relative to the `StreamingAssets` folder
inferenceCallback);

Start audio capture and processing with:

picovoiceManager.Start();

Stop with:

picovoiceManager.Stop();

Release resources acquired by PicovoiceManager with:

picovoiceManager.Delete();
For use-cases where an audio capture pipeline is not required, there's the Low-Level Picovoice API.

Custom Wake Words & Contexts

Create custom wake word and context files using the Picovoice Console. Download the custom models (.ppn and .rhn) and place them in the StreamingAssets folder of the Unity project. Pass the relative paths (from StreamingAssets) to the PicovoiceMananger.Create constructor.

Non-English Languages

Use the corresponding model file (.pv) to process non-English wake words and contexts. The model files for all supported languages are available on the Porcupine GitHub repository and the Rhino GitHub repository.

Pass in model files using the porcupineModelPath and rhinoModelPath input arguments to change the language:

PicovoiceManager picovoiceManager = PicovoiceManager.Create(
"${ACCESS_KEY}",
"${KEYWORD_FILE_PATH}", // path is relative to the `StreamingAssets` folder
wakeWordCallback,
"${CONTEXT_FILE_PATH}", // path is relative to the `StreamingAssets` folder
inferenceCallback,
porcupineModelPath: "${PORCUPINE_MODEL_FILE_PATH}",
rhinoModelPath: "${RHINO_MODEL_FILE_PATH}");

Demo

For the Picovoice Unity SDK, we offer demo applications that demonstrate how to use the Picovoice Platform on real-time audio streams (i.e. microphone input).

Setup

Download and import the latest Picovoice Unity package.

Usage

  1. Open the Picovoice Demo Scene (Picovoice/PicovoiceDemo/PicovoiceDemo.unity).
  2. Copy AccessKey from Picovoice Console into the ACCESS_KEY variable in PicovoiceDemo.cs
  3. Play the scene in the editor or go to File > Build Settings and click the Build and Run button to compile and run the scene for the selected platform.

Resources

Package

  • Pv.Unity.Picovoice on GitHub

API

  • Pv.Unity.Picovoice API Docs

GitHub

  • Picovoice Unity SDK on GitHub
  • Picovoice Unity demos on GitHub

Benchmarks

  • Wake Word Benchmark
  • Speech-to-Intent Benchmark

Further Reading

  • Tutorial: Making a Hands-Free Video Player in Unity

Video

  • Voice-Controlled VR Video Player Made in Unity

Was this doc helpful?

Issue with this doc?

Report a GitHub Issue
Picovoice Platform Unity Quick Start
  • Platforms
  • Requirements
  • Picovoice Account & AccessKey
  • Quick Start
  • Setup
  • Usage
  • Custom Wake Words & Contexts
  • Non-English Languages
  • Demo
  • Setup
  • Usage
  • Resources
Platform
  • Leopard Speech-to-Text
  • Cheetah Streaming Speech-to-Text
  • Octopus Speech-to-Index
  • Porcupine Wake Word
  • Rhino Speech-to-Intent
  • Cobra Voice Activity Detection
Resources
  • Docs
  • Console
  • Blog
  • Demos
Sales
  • Pricing
  • Starter Tier
  • Enterprise
Company
  • Careers
Follow Picovoice
  • LinkedIn
  • GitHub
  • Twitter
  • Medium
  • YouTube
  • AngelList
Subscribe to our newsletter
Terms of Use
Privacy Policy
© 2019-2022 Picovoice Inc.