Porcupine Wake Word
Angular API

API Reference for the Porcupine Angular SDK (npmjs).

PorcupineService

class PorcupineService implements OnDestroy { }

Angular service for Porcupine wake word engine.

PorcupineService.init()

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

Initializes the PorcupineService. Subscribe to keywordDetection$ subject to receive keyword detection events. If loaded, isLoaded$ is set 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.

PorcupineService.start()

async start(): Promise<void>

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

PorcupineService.stop()

async stop(): Promise<void>

Stops keyword detection. If stopped, isListening$ is set to false.

PorcupineService.release()

async release(): Promise<void>

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

PorcupineService.keywordDetection$

keywordDetection$: Subject<PorcupineDetection>

Subject which is updated when a keyword is detected.

PorcupineService.isLoaded$

isListening$: Subject<boolean>

Subject indicating whether PorcupineService has loaded.

PorcupineService.isListening$

isLoaded$: Subject<boolean>

Subject indicating whether the WebVoiceProcessor is passing audio to the engine.

PorcupineService.error$

error$: Subject<string | null>

Subject which contains the error object when an error has occurred.