Suggestions

close search

Release notes for the OpenTok.js library

API referenceTutorials

Welcome to version 2.10 of the OpenTok.js library.

If you have any questions, concerns, feedback, please let us know at our OpenTok Community.


New features
Requirements
Known issues
Fixed issues
More information
How to report bugs

For details on the OpenTok.js API, see the OpenTok.js library reference.

New Features on December 15, 2016 — OpenTok.js 2.10.0

New name property of OpenTok Error objects. The Error object passed into completion handlers for some methods now has a name property. Use this new name property, instead of the code property (which is deprecated), to to identify the error programatically. For more information, see the documentation of the Error object.

Improved video quality in the OpenTok Plugin for Internet Explorer. The plugin uses a better interpolation method, resulting in improved video quality. Also, we have fixed an issued with video flickering when a video's container is resized.

Frame rate statistics available in the Subscriber.getStats() method. The callback function for the Subscriber.getStats() method now includes a video.frameRate property, which is set to the video frame rate of the subscriber's video stream.

Work-around for a Chrome bug in which a Publisher fails to get access to the microphone. This results in a Publish timeout error and a Subscriber error for any subscriber trying to subscribe to the stream. This bug requires the user to restart the browser and reload your page. As a work-around, when this bug occurs, the completion handler of the Session.publish() method is called with an error, and the name property of the error object is set to "OT_CHROME_MICROPHONE_ACQUISITION_ERROR". In this case, you can can notify the user to restart the browser.

Visual indication when a subscriber is reconnecting to a stream. As part of the OpenTok reconnection feature, subscribers will attempt to automatically reconnect to stream if it is dropped unexpectedly. When this occurs, the subscriber element displays an icon indicating that the subscriber is trying to reconnect to the stream (and this icon was added in v2.10.0).

Improved support for networks with authenticated proxies in the OpenTok Plugin for Internet Explorer. For a large number of authenticated proxy networks, clients using Internet Explorer can now publishing and subscribing to streams.

This version also includes bug fixes and performance improvements. For details, see Fixed issues.

Features added in previous versions

Show details.

Requirements

The OpenTok.js library is currently supported in:

The OpenTok.js library uses port 443. Port 443 must be open on the client network.

Known issues

The following are known issues for this version of the OpenTok on WebRTC JavaScript library.

Repositioning and resizing Publisher and Subscriber elements. Do not reparent a a Publisher or Subscriber in the HTML DOM. You can reposition these elements by changing style properties. See this information on resizing and repositioning videos.

Video streaming is prevented on networks that have firewalls that use authenticated proxies. This is due to a core issue with the current underlying WebRTC implementation. (See this Chromium bug report.)

Chrome fails to get access to the microphone, which results in a Publish timeout error and a Subscriber error for any subscriber trying to subscribe to the stream. To work around this issue, the end-user must restart Chrome and reload your site. This is a high-priority bug for Chrome, and they are working on fixing it. When this bug occurs, the completion handler of the Session.publish() method is called with an error, and the name property of the error object is set to "OT_CHROME_MICROPHONE_ACQUISITION_ERROR". In this case, you can can notify the user to restart the browser.

The OpenTok Automatic Reconnection feature does not work in Firefox or Internet Explorer. Firefox has a known issue with offline mode and peer connections (see this Mozilla bug), which Mozilla is working on.

One Publisher in the OpenTok Plugin for Internet Explorer. You can only add one Publisher (within all browser windows and tabs).

Cannot hide a Publisher or Subscriber in the OpenTok Plugin for Internet Explorer. Attempting to hide the a Publisher or Subscriber (by setting style.display to "none" or visibility to "hidden") causes Internet Explorer to crash.

Issue subscribing to your own stream in Internet Explorer. In Internet Explorer, you cannot subscribe to a stream published by your own client.

Setting the frame rate does not work in Firefox on MacOS when using the built-in FaceTime camera. Setting the frameRate option when calling OT.initPublisher() has no effect. This is the Mozilla bug report for the issue.

Setting the frame rate does not work in the OpenTok Plugin for Internet Explorer. Setting the frameRate option when calling OT.initPublisher() has no effect.

Issues setting video source for a Publisher in Firefox. In an page loaded via HTTPS, if the user clicks "Always Share" when granting access to the camera, you can only use that camera. You cannot set the video source to another camera.

The OpenTok plugin for Internet Explorer does not work in sandboxed iframes. This is an intentional limitation of the browser. The browser blocks plugin content inside a sandboxed frame.

WebRTC is a peer-to-peer protocol, and it is possible that connections will fail to connect. The most common cause for failure is a firewall that the protocol cannot traverse. When OpenTok detects this failure, the OT object dispatches an exception event object, with the code property set to 1013.

You cannot publish video on a page loaded from a file:// URL, due to browser security limitations. You need to load the page from an http:// or https:// URL. Note also, that Chrome requires you to load a page from an https:// URL (although you can use http to test a localhost URL in Chrome). For example, you can test a page from http://localhost if you have a web server set up on your local machine.

Fixed in OpenTok.js 2.10.0

Video flickers when its container is resized the OpenTok Plugin for Internet Explorer. We have fixed this issue.

There was a three-second delay when subscribing to a stream in the OpenTok Plugin for Internet Explorer. We have fixed this issue.

The "contain" setting for the fitmode property is not working in the OpenTok Plugin for Internet Explorer. We have fixed this issue.

Publisher objects not dispatching accessDenied events in Firefox 49.0.1. We have fixed this issue.

Screen sharing videos are blurry in the OpenTok Plugin for Internet Explorer. We have fixed this issue.

Publishers and subscribers in Chrome incorrectly displaying a "possible network or firewall issue" message. We have fixed this issue.

The getImgData() method of Subscriber and Publisher objects returns an image with the incorrect resolution in the OpenTok Plugin for Internet Explorer. We have fixed this issue.

Unable to publish in Firefox 42 or lower. We have fixed this issue.

Publishing does not work in Chrome Canary version 57. We have fixed this issue.

Fixed in previous versions

Show details.

More information

See the reference documentation for the OpenTok.js library.

To see sample code and to read more information on using the OpenTok.js library, see the OpenTok Tutorials and Examples page.

For documentation on the OpenTok server-side libraries, see the OpenTok server-side libraries page.

Also check out the OpenTok Help Center.

How to report bugs

We'd love to hear from you! If you have any issues or bugs, you can report them to us at support@tokbox.com.