Rhino Speech-to-Intent
Vue API

API Reference for the Rhino Vue SDK (npmjs).

RhinoVue

type RhinoVue = {
  state: {
    inference: RhinoInference | null;
    contextInfo: string | null;
    isLoaded: boolean;
    isListening: boolean;
    error: string | null;
  },
  init: (
    accessKey: string,
    context: RhinoContext,
    model: RhinoModel,
    options?: RhinoOptions) => Promise<void>;
  process: () => Promise<void>;
  release: () => Promise<void>;
}

RhinoVue type.

• state object : RhinoVue internal states.
  • inference RhinoInference | null : A state containing the inference.
  • contextInfo string | null : Context information.
  • isLoaded boolean : A state indicating whether the engine is initialized successfully.
  • isListening boolean : A state indicating whether the webVoiceProcessor is passing audio to the engine and Rhino is listening for an utterance.
  • error string | null : A string expression of an error when an error is present.
• init () => Promise<void> : A method to initialize Rhino. See init().
• process () => Promise<void> : A method to start processing audio. See process().
• release () => Promise<void> : A method to cleanup resources acquired by Rhino. See release().

useRhino

useRhino(): RhinoVue { }

Vue reactive API for Rhino Speech-to-Intent engine.

Returns

• RhinoVue: States and functions for Rhino Vue binding.

init()

async function init(
    accessKey: string,
    context: RhinoContext,
    model: RhinoModel,
    options?: RhinoOptions
): Promise<void>;

Initializes the Rhino Speech-to-Intent engine. Sets state.isLoaded to true on success.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• context RhinoContext : Object containing Rhino context data.
• model RhinoModel : Object containing Rhino model data.
• options RhinoOptions : Optional configuration arguments.

process()

async function process(): Promise<void>

Puts Rhino in an active state.isListening state. The process function initializes WebVoiceProcessor. Rhino will then listen and process frames of microphone audio until it reaches a conclusion, then return the result via the state.inference state. Once a conclusion is reached Rhino will enter a paused state. From the paused state call process again to detect another inference.

release()

async function release(): Promise<void>

Releases resources acquired by the RhinoVue and resets all internal states.