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.
We recommend using this SDK as part of the overall @vonage/server-sdk
package. Please see the main package for installation.
You can also use this SDK standalone if you only need access to just the Video API.
npm install @vonage/video
yarn add @vonage/video
If you are using this SDK as part of the Vonage Server SDK, you can access it as the video
property off of the client that you instantiate.
const { Auth } = require('@vonage/auth');
const { Vonage } = require('@vonage/server-sdk');
const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};
const vonage = new Vonage(credentials, options);
const session = await vonage.video.createSession();
The SDK can be used standalone from the main Vonage Server SDK for Node.js if you only need to use the Video API. 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
This SDK uses Promises to return data.
const session = await videoClient.createSession();
Run:
npm test
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 | ✅ |
SIP Interconnect | ✅ |
Live Streaming Broadcasts | ✅ |
Experience Composer | ✅ |