@opentok/client

The OpenTok.js library lets you use OpenTok-powered video sessions on the web

Stats

StarsIssuesVersionUpdatedCreatedSize
@opentok/client
2.20.3a month ago4 years agoMinified + gzip package size for @opentok/client in KB

Readme

OpenTok.js

npm version

The OpenTok.js library lets you use OpenTok-powered video sessions on the web.

Installation

yarn add @opentok/client

or

npm install --save @opentok/client

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('@opentok/client');
const publisher = OT.initPublisher();

Bundle the application with your favourite 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/@opentok/client/dist/js/opentok.min.js"></script>
<script>
const publisher = OT.initPublisher();
</script>

Note: OpenTok.js 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://tokbox.com/developer/sdks/js/

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.