Server SDK - Overview

The Engage Server SDK is a Node.js library that provides a convenient way to create Access Tokens and to manage Rooms and Participants.

Installation

npm install @atmokyaudio/engage-server-sdk

Checkout the Installation Guide for how to setup npm.

API Secrets in Environment Variables

The Engage Server SDK requires API secrets to authenticate requests and to sign Access Tokens. It is recommended to store these secrets in environment variables.

ENGAGE_SERVER_URL=<YOUR_SERVER_URL>
ENGAGE_API_KEY=<YOUR_API_KEY>
ENGAGE_API_SECRET=<YOUR_API_SECRET>

And use them in your code like so:

const rsc = new RoomServiceClient(
    process.env.ENGAGE_SERVER_URL!,
    process.env.ENGAGE_API_KEY!,
    process.env.ENGAGE_API_SECRET!
);

⚠️

It's best practice to not check-in API secrets into source control but set them in your CI/CD pipeline or on your server.

Analysing Audio Levels Token Creation