Porcupine Wake Word
Vue Quick Start

Compatibility

• Chrome & Chromium-based browsers
• Edge
• Firefox
• Safari

Requirements

• Picovoice Account and AccessKey
• Node.js 16+
• Vue 2.6.11+, 3.0.0+
• npm

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Node.js.

2. Install the npm packages:

   • @picovoice/porcupine-vue
   • @picovoice/web-voice-processor

npm install @picovoice/porcupine-vue @picovoice/web-voice-processor

Usage

Put the model file in the project's public directory or generate a base64 model using the build in script:

npx pvbase64 -i ${PORCUPINE_PARAMS_PATH} -o ${OUTPUT_FILE_PATH}

Create a porcupineModel object with either of the methods above:

const PORCUPINE_MODEL_BASE64 = /* Base64 representation of the `.pv` model file*/;

const porcupineModel = {
   publicPath: "${MODEL_RELATIVE_PATH}", // or
   base64: PORCUPINE_MODEL_BASE64
}

Create a Vue Component that detects the built-in keywords porcupine and bumblebee:

<script lang='ts'>
import { BuiltInKeyword } from '@picovoice/porcupine-web';
import { usePorcupine } from '@picovoice/porcupine-vue';

export default {
   data() {
      const {
         state,
         init,
         start,
         stop,
         release
      } = usePorcupine();
   
      init(
        ${ACCESS_KEY},
        [BuiltInKeyword.Porcupine],
        porcupineModel
      );
   
      return {
         state,
         start,
         stop,
         release
      }
   },
   watch: {
      "state.keywordDetection": function (keyword) {
         if (keyword !== null) {
            console.log(keyword.label);
         }
      },
      "state.isLoaded": function (isLoaded) {
         console.log(isLoaded)
      },
      "state.isListening": function (isListening) {
         console.log(isListening)
      },
      "state.error": function (error) {
         console.error(error)
      },
   },
   onBeforeDestroy() {
      this.release();
   },
};
</script>

To learn how to use PorcupineVue with Vue's Composition API, check Porcupine Wake Word Vue GitHub Repo.

The binding will take care of microphone access and audio down-sampling ( via @picovoice/web-voice-processor).

To start audio processing:

await this.start();

To stop audio processing:

await this.stop();

Clean up resources explicitly with:

this.release();

Custom Keywords

Create custom keywords using the Picovoice Console. Train and download a Porcupine Wake Word keyword model (.ppn) for the target platform Web (WASM). This model file can be used directly with publicPath, but, if base64 is preferable, convert the .ppn file to a base64 JavaScript variable using the built-in pvbase64 script:

npx pvbase64 -i ${KEYWORD_FILE}.ppn -o ${KEYWORD_BASE64}.js -n ${KEYWORD_BASE64_VAR_NAME}

Similar to the model file (.pv), keyword files (.ppn) are saved in IndexedDB to be used by Web Assembly. Either base64 or publicPath must be set for each keyword to instantiate Porcupine Wake Word. If both are set, Porcupine Wake Word will use the base64 model. An arbitrary label is required to identify the keyword once the detection occurs.

const keywordModel = {
  publicPath: "${KEYWORD_RELATIVE_PATH}",
  // or
  base64: "${KEYWORD_BASE64_STRING}",
  label: "${KEYWORD_LABEL}",
}

Then, initialize an instance of Porcupine Wake Word:

this.$porcupine.init(
   ${ACCESS_KEY},
   [keywordModel],
   porcupineModel
);

Non-English Languages

In order to use Porcupine Wake Word with other languages, you need to use the corresponding model file (.pv) for the desired language. The model files for all supported languages are available on the Porcupine GitHub repository.

Demo

For the Porcupine Wake Word Vue SDK, there is a Vue demo project available on the Porcupine GitHub repository.

Setup

Clone the Porcupine Wake Word repository from GitHub:

git clone --recurse-submodules https://github.com/Picovoice/porcupine.git

Usage

1. Install the dependencies and use the start script with a language code to start the demo in the language of your choice (e.g. de -> German, ko -> Korean). To see a list of available languages, run start without a language code.

cd porcupine/demo/vue
npm install
npm run start ${LANGUAGE}

2. Open the link provided by the command-line output to launch the demo in your browser.

Resources