Jitsi Meet IFrame (External) API

Browser-side JavaScript API (also called the External API) that embeds a Jitsi Meet conference into any web page through an iframe. Exposes the JitsiMeetExternalAPI constructor with commands (executeCommand), functions (getParticipantsInfo, isVideoMuted, etc.), and an event surface (videoConferenceJoined, participantJoined, audioMuteStatusChanged, raise hand, breakout rooms) for controlling the meeting from the host page. The same library powers the embed experience on meet.jit.si, self-hosted deployments, and JaaS.

Jitsi Meet IFrame (External) API is one of 10 APIs that Jitsi publishes on the APIs.io network.

Tagged areas include IFrame, External API, Embedding, Video Conferencing, and JavaScript. The published artifact set on APIs.io includes API documentation.

API entry from apis.yml

apis.yml Raw ↑
aid: jitsi:jitsi-meet-iframe-api
name: Jitsi Meet IFrame (External) API
tags:
- IFrame
- External API
- Embedding
- Video Conferencing
- JavaScript
humanURL: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe
properties:
- url: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe
  type: Documentation
- url: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-functions
  name: IFrame API Functions
  type: Documentation
- url: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-events
  name: IFrame API Events
  type: Documentation
- url: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-commands
  name: IFrame API Commands
  type: Documentation
- url: https://github.com/jitsi/jitsi-meet/blob/master/modules/API/external/external_api.js
  name: external_api.js source
  type: SourceCode
description: Browser-side JavaScript API (also called the External API) that embeds a Jitsi Meet conference
  into any web page through an iframe. Exposes the JitsiMeetExternalAPI constructor with commands (executeCommand),
  functions (getParticipantsInfo, isVideoMuted, etc.), and an event surface (videoConferenceJoined, participantJoined,
  audioMuteStatusChanged, raise hand, breakout rooms) for controlling the meeting from the host page.
  The same library powers the embed experience on meet.jit.si, self-hosted deployments, and JaaS.