@vonage/video

Vonage Video SDK for Node.js

[][../../LICENSE.TXT]

This is the Vonage Video SDK for Node.js for use with Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.

For full API documentation refer to developer.nexmo.com.

• Installation
• Constructor
• Callbacks
• Testing
• Examples
• Supported APIs

Installation

With NPM

npm install @vonage/video

With Yarn

yarn add @vonage/video

Using the Vonage Video SDK

Standalone

The SDK can be used standalone from the main Vonage Server SDK for Node.js if you only need to use the Video APIs. All you need to do is require('@vonage/video'), and use the returned object to create your own client.

const { Auth } = require('@vonage/auth');
const { Video } = require('@vonage/video');

const videoClient = new Video(new Auth({
    applicationId: APP_ID,
    privateKey: PRIVATE_KEY_PATH,
  }), options);

• applicationId - (optional) The Vonage API Application ID to be used when creating JWTs.
• privateKey - (optional) The Private Key to be used when creating JWTs. You can specify the key as any of the following:
  • A Buffer containing the file contents.
  • A String containing the path to the key file on disk.
  • A String containing the key itself.

options is an object that can contain:

• videoHost - (optional) A base URL to use instead of the default https://video.api.vonage.com

Promises

This SDK uses Promises to return data.

const session = await videoClient.createSession();

Testing

Run:

npm test

Examples

Forthcoming.

Supported APIs

The following is a list of Vonage Video APIs and whether the SDK provides support for them:

API	Supported?
Session Creation	✅
Signaling	✅
Force Muting	✅
Archiving	✅
Custom S3/Azure buckets	❌
SIP Interconnect	❌
Live Streaming Broadcasts	❌
Experience Composer	❌
Account Management	❌