Live Streaming Audio Transcription

The Deepgram JavaScript SDK now works in both server and browser environments.

Installing the SDK

1
# Install the Deepgram JS SDK
2
# https://github.com/deepgram/deepgram-js-sdk
3
4
npm install @deepgram/sdk

Initialising the SDK

1
import { createClient } from "@deepgram/sdk";
2
3
const deepgram = createClient("DEEPGRAM_API_KEY");

Connecting to Deepgram

Connecting to Deepgram returns an instance of LiveClient.

1
const live = deepgram.listen.live({ model: "nova-3" });

Live Transcription Options

Transcription options are provided as an object to the live(...options) method. Each of these parameters are found as unique features on the Streaming API reference.

Events

Event’s are available from the SDK as an enum.

1
import { LiveTranscriptionEvents } from "@deepgram/sdk";

Events sent by the SDK

The following events are returned by the SDK.

Listening to Events

The events occur as native JS EventListener events. Please note, .on() is an alias of addEventListener on an EventEmitter.

1
live.on(LiveTranscriptionEvents.Open, () => {
2
  live.on(LiveTranscriptionEvents.Transcript, (data) => {
3
    console.log(data);
4
  });
5
});

Functions

An instance of LiveClient has the following functionality.

Sending Data

You can send raw audio data or text to the web socket without a content type. We will determine the appropriate encoding from the data.

1
 live.send(data);

Keep Alive

You can send Deepgram a keep alive if you intend for deliberate moments of non-billable silence while the socket remains open. The connection will close after 12 seconds if no data is sent, but you will still be billed for an active connection if you’re sending data, even if no audible words are included in the data.

1
live.keepAlive()

Get Ready State

The getReadyState function returns the ready state of the web socket connection to Deepgram.

1
live.getReadyState();

Toggle Features

The configure function gives the ability to toggle different features. Currently, only the numerals feature is supported. This function is a shorthand way of sending the following data to the web socket connection:

1
live.configure({numerals: true}); // enable numerals

Closing the Connection

The requestClose function closes the web socket connection to Deepgram.

1
live.requestClose();