Picovoice Platform
Unity Quick Start
Platforms
- Linux (x86_64)
- macOS (x86_64, arm64)
- Windows (x86_64)
- Android (5.0+, API 21+) (ARM only)
- iOS (11.0+)
Requirements
- Picovoice Account & AccessKey
- Unity 2021.3+
- 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
- Download and install Unity .
- 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
):
Start audio capture and processing with:
Stop with:
Release resources acquired by PicovoiceManager
with:
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 their paths 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:
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
- Open the Picovoice Demo Scene (
Picovoice/PicovoiceDemo/PicovoiceDemo.unity
). - Copy
AccessKey
from Picovoice Console into theACCESS_KEY
variable in PicovoiceDemo.cs - Play the scene in the editor or go to
File > Build Settings
and click theBuild and Run
button to compile and run the scene for the selected platform.