nodejsLeopard - Node.js Quick Start

Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • NVIDIA Jetson Nano
  • Raspberry Pi (3, 4)

Requirements

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 leopard-node npm package:

npm install @picovoice/leopard-node

Usage

Create an instance of the engine:

const Leopard = require("@picovoice/leopard-node");
const accessKey = "${ACCESS_KEY}";
const leopard = new Leopard(accessKey);

Transcribe an audio file by providing an absolute path to the file:

const transcript = leopard.processFile("${AUDIO_FILE_PATH}");

Transcribe raw audio data (sample rate of 16 kHz, 16-bit linearly encoded and 1 channel):

const getAudioData = () => {
// ...
}
const transcript = leopard.process(getAudioData());

Free resources used by Leopard:

leopard.delete()

Demo

For the Leopard Node.js SDK, we offer demo applications that demonstrate how to use the Speech-to-Text engine on audio files.

Setup

Install the Leopard demo package:

npm install -g @picovoice/leopard-node-demo

This package installs command-line utilities for the Leopard Nodejs demos.

Usage

Use the --help flag to see the usage options for the demo:

leopard-file-demo --help

Run the following command to transcribe an audio file:

leopard-file-demo --access_key ${ACCESS_KEY}
--input_audio_file_path ${AUDIO_PATH}

For more information on our Leopard demos for Nodejs, head over to our GitHub repository.

Resources

Packages

API

GitHub

Benchmark


Issue with this doc? Please let us know.