Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update iframe.md #477

Merged
merged 1 commit into from
Nov 16, 2023
Merged

Update iframe.md #477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions docs/dev-guide/iframe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@ The API object constructor uses the following options:
* `domain`: The domain used to build the conference URL (e.g., **`meet.jit.si`**).
* `options`: The object with properties.

Optional arguments include:
IFrame arguments include:

* `roomName`: The name of the room to join.

* `width`: The created IFrame width.
* `width`: _Optional._ The created IFrame width.

The width argument has the following characteristics:

- A numerical value indicates the width in pixel units.

- If a string is specified the format is a number followed by **`px`**, **`em`**, **`pt`**, or **`%`**.

* `height`: The height for the created IFrame.
* `height`: _Optional._ The height for the created IFrame.

The height argument has the following characteristics:

Expand All @@ -85,22 +85,23 @@ The API object constructor uses the following options:

* `parentNode`: The HTML DOM Element where the IFrame is added as a child.

* `configOverwrite`: The JS object with overrides for options defined in the [config.js] file.
* `configOverwrite`: _Optional._ The JS object with overrides for options defined in the [config.js] file.

* `interfaceConfigOverwrite`: The JS object with overrides for options defined in the [interface_config.js] file.
* `interfaceConfigOverwrite`: _Optional._ The JS object with overrides for options defined in the [interface_config.js] file.

* `jwt`: The [JWT](https://jwt.io/) token.
* `jwt`: _Optional._ The [JWT](https://jwt.io/) token.

* `onload`: The IFrame onload event handler.
* `onload`: _Optional._ The IFrame onload event handler.

* `invitees`: Object arrays that contain information about participants invited to a call.
* `invitees`: _Optional._ Object arrays that contain information about participants invited to a call.

* `devices`: Information map about the devices used in a call.
* `devices`: _Optional._ Information map about the devices used in a call.

* `userInfo`: The JS object that contains information about the participant starting or joining the meeting (e.g., email).
* `userInfo`: _Optional._ The JS object that contains information about the participant starting or joining the meeting (e.g., email).

* `lang`: The default meeting language.
* `iceServers`: Object with rules that will be used to modify/remove the existing ice server configuration. **NOTE: This property is currently experimental and may be removed in the future!**
* `lang`: _Optional._ The default meeting language.

* `iceServers`: _Optional._ Object with rules that will be used to modify/remove the existing ice server configuration. **NOTE: This property is currently experimental and may be removed in the future!**


For example:
Expand Down