Add live video streaming to your Cordova Application

Usage no npm install needed!

<script type="module">
  import cordovaPluginOpentokAnnotations from '';


Cordova Plugin for OpenTok iOS and Android

OpenTok Labs

Disclaimer: This plugin is based on the Cordova OpenTok Plugin. Please keep in mind that this is an OpenTok Labs project which means that it's not officially supported by TokBox.

Sample code

To see the plugin in action, please check out opentok-cordova-samples.

Using Cordova CLI

Make sure You have Cordova 3.5.0 or greater installed. If you haven't, take a look at the Cordova instructions Page.

  1. Clone this repo to get the source code for the OpenTok Cordova plugin

  2. To install the OpenTok Cordova plugin, run the following command in the root of your project:

cordova plugin add cordova-plugin-opentok-annotations@version
  1. To remove OpenTok Cordova plugin 3.2.0 and above, use the following command:
cordova plugin remove cordova-plugin-opentok
  1. To remove the old OpenTok Cordova plugin, use the following command:
cordova plugin remove com.tokbox.cordova.opentok

Getting Started on your Project:

All your editing will be done in your www folder.

To use the opentok library, make sure you include opentok.js file in your HTML document.
<script type="text/javascript" charset="utf-8" src="opentok.js"></script>

All JavaScript code should be written in onDeviceReady function in /js/index.js because it is executed after all dependencies has loaded.

    onDeviceReady: function() {
        // Do Your Stuff Here!

Development and Contributing

Interested in contributing? We love pull requests! See the Contribution guidelines.


Currently, annotations code is only supported by Android. It works by using the OT.setIllustration() method, taking the following arguments:

  1. A canvas data array, derived from the getImageData() method
  2. The image data width
  3. The image data height

The custom annotation renderer code can be found in the onFrame method (line 504) of the file, as well as within the updateIllustration method (line 459) in the same file.