@vonage/client-sdk-video

Vonage Video API

The Vonage Video API library lets you use Vonage-powered video sessions on the web.

Installation

yarn add @vonage/client-sdk-video

or

npm install --save @vonage/client-sdk-video

Usage

As a module

The library is bundled as a standalone UMD module so it is CommonJS compatible.

Create your application file app.js:

const OT = require('@vonage/client-sdk-video');
const publisher = OT.initPublisher();

Bundle the application with your favorite bundler. For browserify just run:

browserify app.js > bundle.js

And include the bundle in your webpage:

<script src="bundle.js"></script>

Source maps can be found in dist/js/. Make sure your bundler is configured to include them if you need to generate source maps.

As a global window object

Include the dist/js/opentok.min.js script in your webpage.

Then use the OT object exposed in the global scope.

<script src="node_modules/@vonage/client-sdk-video/dist/js/opentok.min.js"></script>
<script>
const publisher = OT.initPublisher();
</script>

Note: Vonage Video API automatically loads CSS and image files from the TokBox CDN when included in a webpage.

Documentation

The API reference and tutorials can be found at https://developer.vonage.com/en/video/client-sdks/web/overview