Porcupine Wake Word — React API

API Reference for the Porcupine React SDK (npmjs).

usePorcupine()

function usePorcupine(): {
  keywordDetection: PorcupineDetection | null,
  isLoaded: boolean,
  isListening: boolean,
  error: string | null,
  init: (
          accessKey: string,
          keywords: Array<PorcupineKeyword | BuiltInKeyword> | PorcupineKeyword | BuiltInKeyword,
          model: PorcupineModel,
          options?: PorcupineOptions,
  ) => Promise<void>,
  start: () => Promise<void>,
  stop: () => Promise<void>,
  release: () => Promise<void>,
}

React Hook for Porcupine wake word engine.

Returns

• keywordDetection PorcupineDetection | null : A state containing keyword result value.
• 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 string | null : A string expression of the error.
• init (...) => Promise<void> : A method to initialize Porcupine given the arguments. See init.
• start () => Promise<void> : A method to start processing the audio. See start.
• stop () => Promise<void> : A method to stop processing the audio. stop.
• release () => Promise<void> : Releases resources acquired by usePorcupine. See release.

init()

async function init(
  accessKey: string,
  keywords: Array<PorcupineKeyword | BuiltInKeyword> | PorcupineKeyword | BuiltInKeyword,
  model: PorcupineModel
): Promise<void>

Initializes usePorcupine hook. Sets isLoaded state to true.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• keywords Array<PorcupineKeyword | BuiltInKeyword> | PorcupineKeyword | BuiltInKeyword: Object containing Porcupine keyword data.
• model PorcupineModel : Object containing Porcupine model.

start()

async function start(): Promise<void>

Starts keyword detection. If started, isListening is set to true.

stop()

async function stop(): Promise<void>

Stops keyword detection. Sets isListening to false.

release()

async function release(): Promise<void>

Releases resources acquired by the usePorcupine and all internal states.