Picovoice Platform
React API

API Reference for the Picovoice React SDK (npmjs).

usePicovoice()

function usePicovoice(): {
  wakeWordDetection: PorcupineDetection | null;
  inference: RhinoInference | null;
  contextInfo: string | null;
  isLoaded: boolean;
  isListening: boolean;
  error: Error | null;
  init: (
    accessKey: string,
    keyword: PorcupineKeyword,
    porcupineModel: PorcupineModel,
    context: RhinoContext,
    rhinoModel: RhinoModel,
    options?: PicovoiceOptions
  ) => Promise<void>;
  start: () => Promise<void>;
  stop: () => Promise<void>;
  release: () => Promise<void>;
}

React Hook for Picovoice Platform.

Returns

• wakeWordDetection PorcupineDetection | null : A state that is updated when the wake word has been detected.
• inference RhinoInference | null : A state that is updated when an inference has been made.
• contextInfo string | null : A state that updates when Rhino context info is available. Shows the list of intents, which expressions map to those intents, as well as slots and their possible values.
• 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.
• error Error | null : An Error object containing details about the error.
• init (...) => Promise<void> : A method to initialize the internal PicovoiceWorker. See init.
• start () => Promise<void> : A method to start processing the audio. See start.
• stop () => Promise<void> : A method to stop processing the audio. See stop.
• release () => Promise<void> : Releases resources acquired by usePicovoice. See release

init()

async function init(
  accessKey: string,
  keyword: PorcupineKeyword,
  porcupineModel: PorcupineModel,
  context: RhinoContext,
  rhinoModel: RhinoModel,
  options: PicovoiceOptions = {}
): Promise<void>

Initializes the internal PicovoiceWorker. Sets isLoaded state to true if successful.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• keyword PorcupineKeyword : A Porcupine keyword. Can be provided as a built-in, base64 or a hosted .ppn file.
• porcupineModel PorcupineModel : Contains the model parameters that are used to initialize the Porcupine engine. Model can be encoded in base64 or can be stored in a .pv file in a public directory.
• context RhinoContext : A Rhino context. Can be provided as a base64 or a hosted .rhn file.
• rhinoModel RhinoModel : Contains the model parameters that are used to initialize the Rhino engine. Model can be encoded in base64 or can be stored in a .pv file in a public directory.
• options PicovoiceOptions : Optional configuration arguments.

start()

async function start(): Promise<void>

Starts audio recording and processing. If successful, isListening is set to true.

stop()

async function stop(): Promise<void>

Stops audio recording and processing. If successful, isListening is set to false.

release()

async function release(): Promise<void>

Releases resources acquired by the usePicovoice hook and resets all internal states.