Porcupine Wake Word
Vue API

API Reference for the Porcupine Vue SDK (npmjs).

PorcupineVue

type PorcupineVue = {
  state: {
    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>,
};

PorcupineVue type.

• state object : PorcupineVue internal states.
  • 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 PorcupineVue. See release.

usePorcupine()

usePorcupine(): PorcupineVue { }

Vue reactive API for Porcupine wake word engine.

Returns

• PorcupineVue: States and functions for Porcupine Vue binding.

init()

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

Initializes PorcupineVue. Sets state.isLoaded to true.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• keywords Array<PorcupineKeyword | BuiltInKeyword> | PorcupineKeyword | BuiltInKeyword : Built-in or Base64 representations of keywords and their sensitivities. Can be provided as an array or a single keyword.
• model PorcupineModel : Porcupine model options.

start()

function start(): Promise<void>

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

stop()

function stop(): Promise<void>

Stops keyword detection. Sets state.isListening to false.

release()

function release(): Promise<void>

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