Skip to content

Latest commit

 

History

History
92 lines (80 loc) · 2.03 KB

README.md

File metadata and controls

92 lines (80 loc) · 2.03 KB

OpenTok PhoneGap Plugin API Reference

The OpenTok API lets you add live video to your app. Find out more online.

For an overview of the core concepts of OpenTok, please visit our OpenTok Developer Page

This PhoneGap Plugin Library is a subset of the OpenTok JavaScript Library

Usage

To use the OpenTok PhoneGap plugin, include the OpenTok JavaScript file in your HTML file.

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

API

Objects

[Connection](connection.md) Represents a connection to an OpenTok session
[Publisher](publisher.md) Provides information about the publishing stream
[Session](session.md) Provides access to much of the OpenTok functionality.
[Stream](stream.md) Specifies a stream and provides information about it
[Subscriber](subscriber.md) References a stream that you have subscribed to
TB Lets you initialize the OpenTok API and set up exception event handling

Events

exception Triggered when errors or unexpected behavior is encountered
sessionConnected Triggered when session has successfully connected
sessionDisconnected Triggered when a session has disconnected
streamCreated Triggered when new stream has been created in a session
streamDestroyed Triggered when stream has ended in a session