The OpenTok.js library lets you use Vonage Video API-powered video sessions on the web.
This page covers the following topics:
Important — issues fixed in Safari 15.4 and 15.5. Safari versions 15.4 and 15.5 (which ship with iOS 15.4 and 15.5 and macOS 12.3 and 12.4) fix the following issues, which could affect apps that use OpenTok.js (in Safari):
All applications that use the Vonage Video API are composed of two parts:
Client SDKs are also available for iOS and Android. All OpenTok client SDKs can interact with one another. You can learn more about the basics of OpenTok clients, servers, sessions and more on our Video API Basics page.
The best way to learn how to use the OpenTok.js library is to follow our Basic Video Chat tutorial for web:View tutorial
Once you understand the basics of building with OpenTok.js, you can get more detailed information and learn how to customize your application with our Developer Guides. To investigate specific API classes and methods, you can review the OpenTok.js Reference.
To load OpenTok.js in your web page, add the following script tag:
You can also install OpenTok.js using the @opentok/client npm package.
The current version of the OpenTok.js library can interoperate with OpenTok apps written with version 2.21+ of the OpenTok client SDKs:
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.
You can include the OpenTok.js library in your web page using a
The OpenTok.js version number consists of three parts:
For example, v2.4.0 is major version 2, minor version 4 (of major version 2), and revision 0 (of v2.4). As revision versions are released, changes are included in the root minor revision. For example, when v2.2.3 is released, its changes are included in v2.2.
To reference a specific revision, you can include the complete version number (such as "v2.4.0")
src attribute. However, we recommend that you specify only the major version
number. Vonage officially supports the current version of the library. If you are loading an older
version, we ask that you upgrade to take advantage of the latest bug fixes and features in the
Important: Always use the libraries we provide unmodified. This ensures that you use the latest up-to-date, tested code. The Vonage Video API does not support the use of modified libraries.
For more information on specific versions of OpenTok.js, see the OpenTok release notes. To learn when new versions of OpenTok.js become available, subscribe to the the Vonage Video API Announcements forum.