@vonage/video

Vonage Video SDK for Node.js

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.vonage.com.

• Installation
• Usage
• Promise
• Testing
• Supported APIs

Installation

With NPM

npm install @vonage/video

With Yarn

yarn add @vonage/video

Usage

Unlike the other SDK's this package is not include in the Vonage Server SDK for Node.js

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 credentials = new Auth({
  applicationId: APP_ID,
  privateKey: PRIVATE_KEY_PATH,
});
const options = {};
const videoClient = new Video(credentials, options);

Where credentials is any option from @vonage/auth, and options is any option from @vonage/server-client

Promises

This SDK uses Promises to return data.

const session = await videoClient.createSession();

Testing

Run:

npm test

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	❌