Rhino Speech-to-Intent
Angular API

API Reference for the Rhino Angular SDK (npmjs).

RhinoService

class RhinoService implements OnDestroy { }

Angular service for Rhino Speech-to-Intent engine.

RhinoService.init()

async function init(
  accessKey: string,
  context: RhinoContext,
  model: RhinoModel,
  options: RhinoOptions = {}
): Promise<void>

Initializes the RhinoService. Subscribe to the inference$ subject to receive inference events. Sets 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.

RhinoService.inference$

inference$: Subject<RhinoInference>

Subject which is updated when an inference is finalized. The object is of type RhinoInference.

RhinoService.contextInfo$

contextInfo$: Subject<string | null>

Subject which contains the YAML context information once Rhino has loaded.

RhinoService.isLoaded$

isLoaded$: Subject<boolean>

Subject indicating whether the Rhino engine is currently loaded and ready for use.

RhinoService.isListening$

isListening$: Subject<boolean>

Subject indicating whether the WebVoiceProcessor is passing audio to the engine and Rhino is listening for an utterance.

RhinoService.error$

error$: Subject<string | null>

Subject which contains an error string when an error has occurred.

RhinoService.process()

async function process(): Promise<void>

Puts the RhinoService in an active 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 inference$ event. Once a conclusion is reached Rhino will enter a paused state. From the paused state call process again to detect another inference.

RhinoService.release()

async function release(): Promise<void>

Releases resources acquired by the RhinoService.