Embed API for Web

The Embed API lets you add a white-label video calling embed to your page and control it using JavaScript. Using the methods exposed by the API, you can make the embed perform functions like starting or ending a call. You can also add event listeners that will get triggered in response to certain embed events, such as a state change.

Below is an example of a basic Videola.io embed with a pre-populated room name. To establish a call, open this page in two tabs and click the “Call” button in both.

For more examples, check out the Examples section.

Supported Platforms and Compatibility

The Videola.io embed must be placed on an HTTPS page of your web application. Due to security restrictions in certain browsers (e.g. Chrome), the embed WILL NOT work if inserted in a non-secure HTTP page.

The Embed API supports the following devices and platforms:

  • Desktop or laptop:
    • Chrome, Firefox and Opera on Windows, macOS and Linux
    • Safari 11.1 and above on macOS
  • Android phones and tablets:
    • Chrome and Firefox for Android, as well as other Chrome-like browsers
  • iPhone, iPad and iPod touch:
    • Safari (iOS 11.3 and above only)

Screen Sharing Support

The Embed API supports outgoing screen sharing in desktop Chrome 72 and above, as well as in desktop Firefox.

For implementation details, please see see the description of the embed.toggleVideo() method as well as the screenSharingAvailability and streamStateChange events in the JavaScript API Reference. Our Basic Demo also provides an example of accessing the screen sharing functionality through the Embed API.

Exploring Further

Use the table of contents to the right to dig deeper and learn how to use the Videola.io Embed API to add video and voice calling functionality to your web app.