Package Exports

@opentok/client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentok/client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenTok.js

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

Installation

yarn add @opentok/client

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/sourcemaps/. 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/