diff --git a/reference/using-the-whereby-embed-element.md b/reference/using-the-whereby-embed-element.md index 26dda7c..728f871 100644 --- a/reference/using-the-whereby-embed-element.md +++ b/reference/using-the-whereby-embed-element.md @@ -51,7 +51,7 @@ If you aren't using a bundler or a library containing a bundler you can access t The web component has a variety of attributes available to customize the meeting experience for your users. It’s possible for each participant in a meeting to have different attribute combinations. -
| Attribute | Description |
|---|---|
aec=off | Turn off acoustic echo cancellation on audio, useful in situations where higher quality audio is important like in music lessons. AEC must be on in order to use the in room "Noise Reduction" feature. |
agc=off | Turn off automatic gain control (or volume level) on audio. AGC must be on in order to use the in room "Noise Reduction" feature. |
audio=off | Participant joins the room with microphone turned off. |
| Enables/Disables the noise cancellation feature. Can increase CPU load, particularly for older/slower devices. |
autoHideSelfView | Automatically hide the self view in the bottom right. Floating the self view to the bottom right is required in order to hide the self view. Must be used with floatSelf for this feature to work. |
autoSpotlight | Automatically spotlight the local participant on room join. Only works when the participant joining has host privileges. |
avatarUrl=<url> | Set the profile avatar of participant. Images must be a square .png or .jpg, maximum of 64pxx64px |
background=off | Hide the room background. |
| Show/hide the entire bottom toolbar. |
| Show/hide the breakout room feature for the meeting host. |
| Show/hide the meeting diagnostics button, sidebar, and indicators. The rooms top toolbar is required to use the meeting diagnostics feature. |
| Camera permissions are not requested or used at all. On by default. |
cameraEffect=<effect> | Set default camera effect to be used. Still user changeable. Possible values: |
| Show/hide the chat button. |
| Allows you to download the chat transcript from a session once it's finished. This will only enable the chat download functionality for the user that has this parameter included in their URL. |
displayName=<name> | Set display name of participant. Supports any characters except code characters |
externalId=<id> | A custom identifier for the participant. Gets saved in Insights data. Supports alphanumeric characters ( |
floatSelf | Float the self view to the bottom right. |
| Predefine up to 20 groups for the breakout groups function. |
| Show/hide active speaker highlighting in real-time. |
lang=<code> | Set the room UI language. Possible values: Czech |
| Show/hide the leave button. |
| Show/hide the language picker. Hiding the localization options means the user will not be able to change their language preference. |
locking=off | Hide the room lock button. |
logo=off | Hide the logo in the room header. |
| Use a lower resolution by default. |
metadata=<string> | Gets passed on to the corresponding webhooks. |
minimal | Applies a minimal UI. Turns off all controls except for cam and mic. Hidden items: top bar, chat, screensharing, leave button, and Whereby’s default branding. Shown items: Video, audio, and people buttons. |
moreButton=off | Hide the more [...] button. |
participantCount=off | Hide the participant counter. |
people=off | Hide the people button. |
pipButton=off | Hide the Picture in Picture button. |
| Determines if users see the pre-call device and connectivity test. This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off. |
precallCeremonyCanSkip=on | Adds functionality for participants to skip the connectivity test. This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off. |
precallPermissionHelpLink=<url> | Specify custom help link in pre-call review step pointing users to additional support pages. |
| Determines if users see the pre-call review step. |
roomIntegrations=on | Enables YouTube and Miro integrations in the meeting. It is recommended you do testing to verify these integrations behave as expected before releasing to your users. |
| Show/hide the screenshare button. |
settingsButton=off | Hide the settings button. |
skipMediaPermissionPrompt | Skip the 'request permissions' screen and immediately trigger the browser’s camera/microphone prompt |
| Enable name labels for participants in the subgrid. |
| Show/hide the meeting timer. |
toolbarDarkText | Sets button icon labels color to black. |
toolbarText=ontoolbarText=off | Removes text from labels in the room toolbar. |
| Show/hide the entire top toolbar. |
video=off | Participant joins the room with camera turned off. |
virtualBackgroundUrl=<url> | Specify custom virtual background which should be applied to the local participant. The image must be provided in 1280x720 resolution in either |
| Attribute | Description |
|---|---|
aec=off | Turn off acoustic echo cancellation on audio, useful in situations where higher quality audio is important like in music lessons. AEC must be on in order to use the in room "Noise Reduction" feature. |
agc=off | Turn off automatic gain control (or volume level) on audio. AGC must be on in order to use the in room "Noise Reduction" feature. |
audio=off | Participant joins the room with microphone turned off. |
| Enables/Disables the noise cancellation feature. Can increase CPU load, particularly for older/slower devices. |
autoHideSelfView | Automatically hide the self view in the bottom right. Floating the self view to the bottom right is required in order to hide the self view. Must be used with floatSelf for this feature to work. |
autoSpotlight | Automatically spotlight the local participant on room join. Only works when the participant joining has host privileges. |
avatarUrl=<url> | Set the profile avatar of participant. Images must be a square .png or .jpg, maximum of 64pxx64px |
background=off | Hide the room background. |
| Show/hide the entire bottom toolbar. |
| Show/hide the breakout room feature for the meeting host. |
| Show/hide the meeting diagnostics button, sidebar, and indicators. The rooms top toolbar is required to use the meeting diagnostics feature. |
| Camera permissions are not requested or used at all. On by default. |
cameraEffect=<effect> | Set default camera effect to be used. Still user changeable. Possible values: |
| Show/hide the chat button. |
| Allows you to download the chat transcript from a session once it's finished. This will only enable the chat download functionality for the user that has this parameter included in their URL. |
displayName=<name> | Set display name of participant. Supports any characters except code characters |
externalId=<id> | A custom identifier for the participant. Gets saved in Insights data. Supports alphanumeric characters ( |
floatSelf | Float the self view to the bottom right. |
| Predefine up to 20 groups for the breakout groups function. |
| Show/hide active speaker highlighting in real-time. |
lang=<code> | Set the room UI language. Possible values: Czech |
| Show/hide the leave button. |
| Show/hide the language picker. Hiding the localization options means the user will not be able to change their language preference. |
locking=off | Hide the room lock button. |
logo=off | Hide the logo in the room header. |
| Use a lower resolution by default. |
metadata=<string> | Gets passed on to the corresponding webhooks. |
minimal | Applies a minimal UI. Turns off all controls except for cam and mic. Hidden items: top bar, chat, screensharing, leave button, and Whereby’s default branding. Shown items: Video, audio, and people buttons. |
moreButton=off | Hide the more [...] button. |
participantCount=off | Hide the participant counter. |
people=off | Hide the people button. |
pipButton=off | Hide the Picture in Picture button. |
| Determines if users see the pre-call device and connectivity test. This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off. |
precallCeremonyCanSkip=on | Adds functionality for participants to skip the connectivity test. This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off. |
precallPermissionsHelpLink=<url> | Specify custom help link in pre-call review step pointing users to additional support pages. |
| Determines if users see the pre-call review step. |
roomIntegrations=on | Enables YouTube and Miro integrations in the meeting. It is recommended you do testing to verify these integrations behave as expected before releasing to your users. |
| Show/hide the screenshare button. |
settingsButton=off | Hide the settings button. |
skipMediaPermissionPrompt | Skip the 'request permissions' screen and immediately trigger the browser’s camera/microphone prompt |
| Enable name labels for participants in the subgrid. |
| Show/hide the meeting timer. |
toolbarDarkText | Sets button icon labels color to black. |
toolbarText=ontoolbarText=off | Removes text from labels in the room toolbar. |
| Show/hide the entire top toolbar. |
video=off | Participant joins the room with camera turned off. |
virtualBackgroundUrl=<url> | Specify custom virtual background which should be applied to the local participant. The image must be provided in 1280x720 resolution in either |

