search

opentok / cordova-plugin-opentok

Cordova Plugin for OpenTok - add webrtc video to your iOS or Android App
MIT License
30 stars 80 forks source link
android cordova ios javascript opentok opentok-labs tokbox webrtc

readme

Cordova Plugin for OpenTok iOS and Android

Tokbox is now known as Vonage

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 Vonage.

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
  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="https://github.com/opentok/cordova-plugin-opentok/raw/main/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 :heart: pull requests! See the Contribution guidelines.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either: