Embed iFrame Options Explained
In this guide we will go through all the iFrame options available in the create room page and explain them in detail.
Screenshots below show the new dashboard. If you use the classic dashboard, pick the Classic dashboard tab — your choice is remembered on every page. You can switch at any time: Old dashboard in the header takes you back to the classic dashboard, and dashboard.metered.ca/v2 opens the new one. What changed in the new dashboard →
- New dashboard
- Classic dashboard
The iFrame options are in the iFrame options section of the Create a room page (and of a room's Edit page). The new dashboard names some of them differently; the explanations below use the classic names:
| Classic name (used below) | New dashboard |
|---|---|
| Camera on join | Camera on by default |
| Microphone on join | Microphone on by default |
| Screen Sharing | Allow screen sharing |
| Text Chat | Enable text chat |
| New Chat For Meeting Session | New chat per meeting session |
| Request to Join | Request-to-join flow |
| Show Invite Instruction | Show invite dialog |
| Auto Join | Auto-join |
| Admin Only broadcast | Admin-only broadcast |
The iFrame options section also has Allow camera (turn it off to force an audio-only experience without changing pricing) and Allow microphone (turn it off to force listen-only mode), and Chat history retention, which sets how long chat messages are kept.
The following are the iFrame options available in the Create Room page of Metered, let go through each option:
Camera on join
When this option is set, the camera of the user will be shared when the user joins the meeting. It is used in conjunction with "Auto Join". Users can still control their settings after they join the meeting.
Microphone on join
This option is similar to "Camera on join" option but instead of camera here it will be microphone.
Screen Sharing
When this option is enabled, the users will be able to share their screen. If this option is disabled then the screen sharing button will be hidden from all users. If you want to disable screen sharing for some specific users then you can also disableScreenSharing option of the Metered Embed Frame SDK.
Text Chat
When enable, users can text chat with each other, when disable text chat is disabled in the meeting. If you want to disable screen sharing for some specific users then you can also disableChat option of the Metered Embed Frame SDK.
New Chat For Meeting Session
When enable a new chat room is created for each meeting session with separate chat history. When disabled the chat is associated with the room, and all the meeting sessions of that room has the same chat history.
Request to Join
When meeting privacy setting is set to private and Request to Join is enabled then users who do not have an accessToken can request to join the meeting. A notification is sent to the admin of the meeting, when admin accepts the request the user is able to join the meeting.
Show Invite Instruction
When there is only one participant in a meeting, the invite instructions are shown with the meetingURL, by disabling this option you can hide the invite instructions.
Auto Join
When the enabled the Lobby / Join Meeting Page is not displayed and the user directly enters the meeting.
Admin Only broadcast
When enabled only admin can share his/her camera/microphone and screen. Admin can in the meeting select the participants and allow them to share their camera/microphone/screen. But by default everyone else except for the admins can share their camera/mic/screen.