OpenTok on WebRTC JavaScript library release notes

Welcome to the public release of the OpenTok on WebRTC JavaScript library — version 2.0.5! If you have any questions, concerns, feedback, please let us know on our forums.

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

For details on the OpenTok on WebRTC JavaScript API, see the OpenTok on WebRTC JavaScript library reference.

Announcements

Mantis beta — Mantis acts as a central switching station for non-peer-to-peer WebRTC streams. Mantis enables:

• High-quality multi-party video calls
• Reduced upload bandwidth consumption, with the ability to scale out a single WebRTC steam to many endpoints
• Cross-browser compatibility for Chrome, Firefox and Internet Explorer 9 (through Google Chrome Frame)
• Interop with iOS apps built using the OpenTok on WebRTC iOS SDK version 2.1.2.

For more information, see the OpenTok blog. If you are interested participating in the beta, please contact us at mantis@tokbox.com.

New Features on May 13, 2013 — v2.0.5

API for setting the audio level of a subscriber — You can set the initial volume of a Subscriber by setting the audioVolume property of the properties parameter of the Session.subscribe() method. You can get and set the audio level of a Subscriber by calling the getAudioVolume() and setAudioVolume() methods of the Subscriber object. For more information, see the documentation for Session.subscribe(), Subscriber.getAudioVolume(), and Subscriber.setAudioVolume().

Features added in previous versions

Show details.

<meta http-equiv="X-UA-Compatible" content="chrome=1">

Requirements

The OpenTok on WebRTC JavaScript library is currently supported in:

• Google Chrome
• Firefox beta — To enable WebRTC code in Firefox, browse to about:config and change the media.peerconnection.enabled preference to true.
• Internet Explorer 9 using the Google Chrome Frame plug-in.

  Be sure to include the following meta tag in your code:

  <meta http-equiv="X-UA-Compatible" content="chrome=1">

  This meta tag is required for the OpenTok on WebRTC library to run in Internet Explorer with the Chrome Frame plug-in.

Known issues

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

The following APIs do not work in the current release of OpenTok on WebRTC:

• The publishVideo property of the properties parameter of the TB.initPublisher() method (Publishers always publish video)
• The publishVideo() method of the Publisher class
• The subscribeToVideo() methods of the Subscriber class

The reason property is always undefined for the ConnectionEvent, SessionDisconnectEvent, and StreamEvent objects. This property should be defined for connectionDestroyed (ConnectionEvent), sessionDisconnected (SessionDisconnectEvent), and streamDestroyed (StreamEvent) events. We are working on fixing this issue.

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 TB object dispatches an exception event object, with the code property set to 1013.

You cannot publish using WebRTC on a page loaded from a file:// URL. You need to load the page from an http:// URL. For example, you can test a file from http://localhost if you have a web server set up on your local machine.

There are a number of WebRTC issues in Chrome:

• Audio echoes in Chrome on Mac OS. We have reported this issue to Google. If this issue affects you, please go to the URL for the issue and click the star to vote on the issue.
• Once a user denies access to the camera and microphone for a site, the user is no longer prompted to allow access on a subsequent visit. We have reported this issue to Google. As a work-around, navigate to chrome://settings/contentExceptions#media-stream and remove blocked sites from the list of media exceptions. If this issue affects you, please go to the URL for the issue and click the star to vote on the issue.
• Changed UI for selecting a specific microphone or camera. We have reported this issue to Google. Navigate to chrome://settings/content, and under "Media," select the microphone and camera. If this issue affects you, please go to the URL for the issue and click the star to vote on the issue.

Fixed issues

Fixed in v2.0.4

The following audio toggle APIs did not work:

• The publishAudio property of the properties parameter of the TB.initPublisher() method (Publishers always published audio)
• The publishAudio() method of the Publisher class
• The subscribeToAudio() methods of the Subscriber class

If a client subscribes to a stream after the publisher mutes audio for the stream, the client hears the publisher's audio. We have fixed this issue.

You cannot use the same session ID in the OpenTok library and the OpenTok on WebRTC library. We have fixed this issue.

Fixed in previous versions

Show details.

More information

For more documentation on the OpenTok on WebRTC JavaScript library, see the OpenTok on WebRTC library reference.

To see sample code, see the OpenTok on WebRTC Hello World.

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

Also check out the OpenTok Developer FAQs page.

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.