Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

Release notes for the OpenTok.js library

Welcome to version 2.23 of the OpenTok.js library.

If you have any questions, Vonage Support is here to help.


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

Announcements

Safari versions 15.4 and 15.5 (which ship with iOS 15.4 and 15.5 and macOS 12.3 and 12.4) fix issues that affect apps that use OpenTok.js (in Safari). See this note.

OpenTok.js now includes beta support for Google Chrome for iOS and Firefox for iOS.

OpenTok.js version 2.16 was the last version to support the OpenTok Plugin for Internet Explorer. OpenTok.js version 2.16 was deprecated in May 2020 for the Standard environment and June 2020 for the Enterprise environment. Support for the OpenTok plugin for Internet Explorer was removed in OpenTok 2.17.

OpenTok.js fully supports Chromium-based versions of Microsoft Edge (versions 79+) for Windows and macOS.

Safari now supports the VP8 video codec, in addition to H.264. VP8 support is in Safari 12.1, which ships on macOS 10.14.4 and is also available for macOS 10.13.6 and 10.12.6. And it is available in the latest iOS 12.2 release. For information on video interoperability and other issues, see the Safari browser support page. For more information on video codecs, see this developer guide.

As of Chrome 72 and Opera 59, an extension is no longer needed for screen sharing. Chrome prompts the end user for access to a screen, window, or tab, as it would for access to the camera. In the current versions of Chrome, Firefox, and Opera, you no longer need to deploy a screen-sharing extension.

On macOS 10.15+ (Catalina), to publish a screen-sharing stream the user must grant the browser access to the screen in macOS System Preferences > Security & Privacy > Privacy > Screen Recording. Otherwise, the Publisher will dispatch an accessDenied event.

New Features in OpenTok.js 2.23

New Features in OpenTok.js 2.23.6 — September 2022

Added support to update custom TURN credentials. See the documentation for the Session.setIceConfig() method. This is available for projects that use the configurable TURN server add-on. This is a beta feature.

New Features in OpenTok.js 2.23.5 — September 2022

Added support for third-party images in a background replacement filter. This is a beta feature. You can now use an image from a remote source (from a domain other than that of the web page) in a background replacement filter for a published stream. See the documentation for the videoFilter option of the OT.initPublisher() method.

This release fixes some issues — see the list of fixed issues.

New Features in OpenTok.js 2.23.4 — August 2022

Added support for Insertable Streams for audio. This is a beta feature. You can apply custom audio transformations to a published stream using the Publisher.setAudioMediaProcessorConnector() method. You can also integrate with the Vonage media processor library to apply additional transformations. For more information, see this developer guide.

Added support for Video Filters when using custom video streams. A custom stream is a stream published with a MediaStreamTrack object as the video source. This is a beta feature. You can apply custom video filters to a publisher using the Publisher.applyVideoFilter() method.

This release fixes some issues — see the list of fixed issues.

New Features in OpenTok.js 2.23.3 — August 2022

Added support for Insertable Streams for video. This is a beta feature. You can apply custom video transformations to a published stream using the Publisher.setVideoMediaProcessorConnector() method. You can also integrate with the Vonage media processor library to apply additional transformations. For more information, see this developer guide.

This release fixes some issues — see the list of fixed issues.

New Features in OpenTok.js 2.23.2 — July 2022

This release fixes some issues — see the list of fixed issues.

New Features in OpenTok.js 2.23.1 — July 2022

Added support for the background replacement filter. This is a beta feature. You can apply the background replacement filter to a published stream. See the documentation for the videoFilter option of the OT.initPublisher() method.

This release fixes some issues — see the list of fixed issues.

New Features in OpenTok.js 2.23.0 — June 2022

Added a method to check if the browser supports video filters. This was previously a beta feature. See the documentation for the OT.hasMediaProcessorSupport() method. This method reports whether the browser supports video filters, which require media processor support. (Currently, only a background blur filter is supported.) Also, see the docs for the Publisher.applyVideoFilter(), Publisher.getVideoFilter(), and Publisher.clearVideoFilter() methods.

Added support for filtering video for publishers using Chromium-based browsers. This was previously a beta feature. Currently, only a background blur filter can be applied. See the videoFilter property of the option parameter you pass into OT.initPublisher() method. Also, see the docs for the Publisher.applyVideoFilter(), Publisher.getVideoFilter(), and Publisher.clearVideoFilter() methods.

Added support for Full High Definition (1080p). You can specify '1920x1080' as the resolution property of the options you pass into the OT.initPublisher() method. This was previously a beta feature.

New feature that implements scalable video support for screen sharing. This was previously a beta feature. See the scalableScreenshare option for the OT.initPublisher() method.

This release fixes some issues — see the list of fixed issues.

Features added in previous versions

Show details.

Requirements

The OpenTok.js library is currently supported in:

Important: OpenTok.js version 2.16 was the last version to support the OpenTok Plugin for Internet Explorer. OpenTok.js version 2.16 was deprecated in May 2020 for the Standard environment and June 2020 for the Enterprise environment.

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 OpenTok.js:

On Android 13, Firefox microphone and camera permissions require a device restart. After you set the permissions in the browser, you need to restart the device for the permissions to take effect.

On iOS 16, video resolution may be incorrect when switching orientation. Rotating a device running iOS 16 may not cause the video resolution to be properly updated. This has been reported as a WebKit bug. Note that iOS 16 is currently in beta, and there is a pull request to fix this issue.

iOS Safari audio and video loss after incoming phone call. After an iOS device accepts an incoming phone call and returns to an OT session, the audio and video from the iOS device may be dropped. This has been reported here and here as WebKit bugs.

When background blur is enabled, cycling video may cause the camera LED to remain on, when calling Publisher.publishVideo(false). We are working on a fix for this issue.

Changing the background blur strength may cause a memory leak. We are working on a fix for this issue.

Changing the background blur strength may cause the publisher's view to be momentarily black. We are working on a fix for this issue.

Publishing at Full High Definition (1080p) resolution in Firefox on macOS fails. This issue has been reported as a Mozilla bug.

Audio degradation over time on iOS/iPadOS devices with Safari. The audio quality for streams published from Safari on iOS/iPadOS may degrade over time with a growing crackling/distortion sound. This issue has been reported as a WebKit bug.

Audio not changing when using Chrome's "Share this tab instead" feature. Chrome does not use audio from the selected tab. We anticipate that the issue will be fixed in Chrome 103. This issue has been reported as a Chromium bug.

Audio issues when using Bluetooth devices in Safari 15. When subscribing to audio using Bluetooth devices, the audio may sound as if a filter was applied to it. For example, the audio received may sound robotic. We anticipate that the issue will be fixed in Safari 15.4. This issue has been reported as a WebKit bug.

Video can flicker for streams with the videoType set to "custom". This can happen if video content doesn't change much. Setting the content hint to text or detail mitigates the issue. See this developer guide topic and the documentation of the videoContentHint property the options you pass into the OT.initPublisher() method and the Publisher.setVideoContentHint() method. This issue has been reported as a Chromium bug.

Audio issues when pausing and unpausing the camera or screen sharing in Safari 15.2. In the address bar in Safari, if you click the camera icon and select the Pause option followed by the Unpause option, you will hear your own audio in the speaker. This issue also occurs if you share your screen. However, it does not occur in Safari on iOS, which does not include the Pause camera option or screen-sharing capabilities. This issue has been reported as a WebKit bug.

In Electron 17, an upcoming API change may cause screen-sharing to fail. See this Electron documentation page for details on the upcoming change. To use screen-sharing in Electron 17 onward, you may need to make some changes in your application. See the Electron 17 sample application screen-sharing with the OpenTok.js library.

In iOS 15, publishing video using an HTML Canvas element as the video source may fail. See this WebKit bug report.

On iOS 14.7+, the publisher's view may be black after being interrupted by Compact UI phone calls. See this WebKit bug report.

The accessDialogOpened event may be erroneously dispatched. When calling the OT.getUserMedia() method, the accessDialogOpened event may be dispatched, even though no access dialog was shown.

In relayed sessions, publishers may be unable to set audio bitrate of their audio stream. OpenTok.js v2.21.1 fixes this issue.

For some Android web users, device orientation may corrupt the publisher's video stream. We anticipate that the issue will be fixed on Chrome 97. This issue affects a subset of users in a VP8 session where the Chrome experimental "WebRTC hardware video encoding" setting is enabled. Disabling "WebRTC hardware video encoding" mitigates the issue. Changing the device's orientation may help as well, but artifacts (such as a green bar at the bottom of the video) may still be present. See this Chromium bug report. The issue also impacts mobile Firefox users. See this Mozilla bug report.

On iOS 14.5, publishers who mute themselves may not be able to unmute. We anticipate that the issue will be fixed on iOS 14.6. See this WebKit bug report.

Critical audio bug in Safari 14.0.1, Safari 14.0.2, and iOS 14.2. Audio playback is stuttering in these browsers. This issue has been resolved in iOS 14.3, and it is expected to be resolved in Safari 14.0.3 (for macOS) when it is released. iOS users are advised to update to iOS 14.3, and macOS users are advised to use another supported browser until Apple releases Safari 14.0.3. See this WebKit bug report.

In Safari 13.1, if you call OT.getDevices() prior to OT.initPublisher(), the publisher will not include a video stream. We anticipate that the issue will be fixed in Safari 13.2.

If you call publishAudio(false) in a routed session, clients using Chrome 65 fail to subscribe. We are working on a fix for this issue.

Publisher audio level meter and audioLevelUpdated events not working in Chrome 66. See this Chromium bug report.

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 in the OpenTok Plugin for Internet Explorer. Attempting to hide the a Publisher (by setting style.display to "none" or by setting visibility to "hidden") can cause the publisher to fail. As a workaround, you can set the width and height of the publisher to 2 or more pixels each; make sure that the publisher is in the DOM; and then when the Publisher object dispatches the streamCreated event, set the visibility to "hidden".

Safari clients sometimes cannot subscribe to streams published in Firefox. If the Safari client is not first publishing a stream, it cannot subscribe to a stream published by a client using Firefox. This is due to a known issue in Safari.

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 audio bitrate is not supported in streams published in Firefox. Setting the audioBitrate option of the OT.initPublisher() method has no effect in Firefox.

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.

Echo cancellation disabled with stereo audio input in Chrome. Some browsers (such as Chome 73+) do not support echo cancellation for stereo audio (see this Chrome issue report).

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.

In Chrome, publishing is not supported on http (insecure) pages (except for http://localhost). You must serve the page over https (secure). Note that for testing, you can also load a page from the local file system (from the file: URI scheme).

Chrome on Android fails to subscribe to videos in Safari projects. This only occurs in routed OpenTok sessions (sessions that use the OpenTok Media Router). OpenTok.js v2.13 fixes this issue in relayed sessions. See this Chromium bug report.

Desktop Safari displays videos upside down when using picture in picture mode. This issue only occurs when subscribing to a video stream published by an iOS Safari client in a routed session.

Fixed in OpenTok.js 2.23.5

Publisher.getStyle() was returning an incorrect TypeScript definition. We have fixed this issue.

In routed sessions, publishing with muted video may take longer than usual. We have fixed this issue.

In some cases, when a video filter was applied, performance was sluggish. We have fixed this issue.

Fixed in OpenTok.js 2.23.4

In relayed sessions, audio and video may be momentarily desynchronized during the start of a session. We have fixed this issue.

There was a momentary blip when changing video backgrounds. We have fixed this issue.

There was a missing typescript definition for setVideoMediaConnector. We have fixed this issue.

Fixed in OpenTok.js 2.23.3

When background blur is enabled, the camera LED would remain on after disconnecting from a session. We have fixed this issue.

When background blur or replacement is enabled, some assets were download from non-OpenTok domains. We have fixed this issue.

The TypeScript type definition was missing for videoFilter type BackgroundReplacementFilter We have fixed this issue.

Fixed in OpenTok.js 2.23.2

With IP proxy enabled, using background blur disables some client logs. These logs are used for analytics and tools like Inspector. We have fixed this issue.

In Firefox, switching a publisher’s camera while enabling/disabling the video may not result in the correct camera image being displayed. We have fixed this issue.

Fixed in OpenTok.js 2.23.1

Currently on relayed sessions when using picture-in-picture mode, MacOS Safari flips video received from iOS browsers. We have fixed this issue.

When changing the level of blurriness of a background blur video filter, a black screen is displayed momentarily. This happens when calling the Publisher.applyVideoFilter() method with a new blurStrength value. We have fixed this issue.

Turning background blur off and on or changing it could cause a memory leak. We have fixed this issue.

Fixed in OpenTok.js 2.23.0

The TypeScript type definition was missing for the PublisherProperties.enableStereo We have fixed this issue.

When publishers were reused in a different session, their properties were not being updated. We have fixed this issue.

Fixed in OpenTok.js 2.22.4

In some cases, screen sharing was muted when audio was toggled. We have fixed this issue.

In relayed sessions, maximum bitrate was not being limited. We have fixed this issue.

Fixed in OpenTok.js 2.22.3

Subscribing to streams in Safari 15+ can fail in relayed sessions. We have fixed this issue.

Fixed in OpenTok.js 2.22.2

In some cases, the publisher’s connection was broken after cycling video when a device was unavailable. We have fixed this issue.

Fixed in OpenTok.js 2.22.1

In some cases, users may momentarily see a black square when video is playing. We have fixed this issue.

Fixed in OpenTok.js 2.21.8

In some cases, screen sharing was muted when audio was toggled. We have fixed this issue.

Fixed in OpenTok.js 2.21.7

Using Safari on iOS 15.2, the subscriber’s view could be black after being interrupted by Compact UI phone calls. We have fixed this issue.

In some cases, an incorrect error code ('OT_STREAM_LIMIT_EXCEEDED') was returned when failing to subscribe. We have fixed this issue.

Fixed in OpenTok.js 2.21.6

The Publisher maxResolution constraint for screen sharing was ignored in Safari. We have fixed this issue.

OT.setAudioOutputDevice() was missing from the TypeScript definition. We have fixed this issue.

OT.getAudioOutputDevice() was missing from the TypeScript definition. We have fixed this issue.

Fixed in OpenTok.js 2.21.5

In some cases, the publisher’s connection was occasionally being destroyed after a short reconnection. We have fixed this issue.

Fixed in OpenTok.js 2.21.2

In some cases, the publisher’s connection was occasionally being destroyed after a short reconnection. 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 our support page.