unityRhino — 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

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 Rhino Unity package.

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

Usage

Create an instance of Rhino using either a pre-built context file (.rhn) from the Rhino GitHub Repository or a custom context created with the Picovoice Console:

using Pv.Unity;
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
}
}
RhinoManager rhinoManager = RhinoManager.Create(
"${ACCESS_KEY}",
"${CONTEXT_FILE_PATH}", // path is relative to the `StreamingAssets` folder
inferenceCallback);

Start audio capture and intent inference with:

rhinoManager.Process();

Once an inference has been made, the inferenceCallback will be invoked and audio capture will stop automatically.

Release resources acquired by RhinoManager with:

rhinoManager.Delete();

Custom Contexts

Create custom contexts using the Picovoice Console. Download the custom context file (.rhn) and place it in the StreamingAssets folder of the Unity project. Pass the relative path (from StreamingAssets) to the RhinoManager.Create constructor.

Non-English Languages

Use the corresponding model file (.pv) to make inferences in non-English contexts. The model files for all supported languages are available on the Rhino GitHub repository. Pass in the model file using the modelPath input argument to change the language:

RhinoManager rhinoManager = RhinoManager.Create(
"${ACCESS_KEY}",
"${CONTEXT_FILE_PATH}",
inferenceCallback,
modelPath: "${MODEL_FILE_PATH}");

Demo

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

Setup

Download and import the latest Rhino Unity package.

Usage

  1. Open the Rhino Demo Scene (Rhino/RhinoDemo/RhinoDemo.unity).
  2. Copy AccessKey from Picovoice Console into the ACCESS_KEY variable in RhinoDemo.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

Packages

API

GitHub

Benchmark

Further Reading

Videos


Issue with this doc? Please let us know.