Gruveo Embed API for Web - Gruveo for Developers

Gruveo Embed API for Web

The Embed API lets you add a Gruveo embed to your page and control the embed 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 Gruveo embed with a pre-populated room name. (For more, check out the Examples section.)

Supported Platforms and Compatibility

Gruveo must be embedded in 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
    • Microsoft Edge on Windows (experimental support, requires setting the enableedgesupport parameter)
    • 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

Support for screen sharing in the Embed API is expected to come in May 2018.

Exploring Further

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