| description |
|---|
With Attributes or URL Parameters you can customize the meeting experience for each individual user after the room has been created. |
Attributes can be used on Whereby's pre-built Web Component by adding them to the <whereby-embed> element.
{% hint style="info" %} Note that Attributes and URL Parameters are only compatible with Whereby's pre-built UI and will not work with the React SDK. {% endhint %}
For example, the following component would open the room with the screenshare and people buttons hidden:
<whereby-embed
room="https://subdomain.whereby.com/your_room?roomKey=3fe345a"
screenshare=off
people=off
/>
URL Parameters are used with an iframe implementation and appended directly to the roomUrl. Several parameters can be combined by using the ampersand symbol (&).
For instance, the following iframe implementation uses URL parameters to disable the screenshare and people buttons:
{% code overflow="wrap" lineNumbers="true" %}
<iframe
src="https://subdomain.whereby.com/room?screenshare=off&people=off"
allow="camera; microphone; fullscreen; display-capture; autoplay; compute-pressure"
/>{% endcode %}
| Attribute/Param | Description | Notes |
|---|---|---|
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 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. | |
audioDenoiser=<on|off> | Enables/Disables the noise cancelation 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 The image URL must be listed in the allowed domains section of the dashboard. The image URL must be https and cannot contain query params. |
background=off | Hide the room background. | |
bottomToolbar=<on|off> | Show/hide the entire bottom toolbar. | |
breakout=<on|off> | Show/hide the breakout room feature for the meeting host. | |
callQualityMonitoring=<on|off> | Show/hide the meeting diagnostics button, sidebar, and indicators | The rooms top toolbar is required to use the meeting diagnostics feature. |
cameraAccess=<on|off> | Camera permissions are not requested or used at all. On by default. | |
cameraEffect=<effect> | Set default camera effect to be used. Still user changeable. | Values: slight-blur, blur, image-cabin, image-concrete, image-brick, image-sunrise, image-day, image-night |
chat=<on|off> | Show/hide the chat button | |
chatTranscriptDownloadOn | 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 $!<>:; and can be up to 100 characters long. Strings not in this format will be rejected and the user will be prompted to enter a different display name instead. |
externalId=<id> | A custom identifier for the participant. Gets saved in Insights data | Supports alphanumeric characters (A-Za-z0-9-_) and can be up to 36 characters long. Strings not in this format will be rejected and return an error. We recommend the UUID v4 format. |
floatSelf | Float the self view to the bottom right | |
groups=Orange,Banana,Coconut | Predefine up to 20 groups for the breakout groups function. | |
lang=<code> | Set the room UI language. | Czech cs, Chinese (Traditional) zh-hant, Danish da, Dutch nl, English en, French fr, German de, Greek el, Hindi hi, Hungarian hu, Italian it, Japanese jp, Norwegian nb, Portuguese pt, Polish pl, or Spanish es |
leaveButton=<on|off> | Show/hide the leave button. | |
localization=<on|off> | 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. | |
lowData=<on|off> | 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: Status bar, chat, screensharing, leave button, and Whereby’s 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. | |
precallCeremony=<on|off> | 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 | |
precallReview=<on|off> | 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. |
screenshare=<on|off> | Show/hide the screenshare button. | |
settingsButton=off | Hide the settings button. | |
skipMediaPermissionPrompt | Skips the request permissions UI and asks for devices | |
subgridLabels=<on|off> | Enable name labels for participants in the subgrid | |
timer=<on|off> | Show/hide the meeting timer. | |
toolbarDarkText | Sets button icon labels color to black. | |
topToolbar=<on|off> | 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 image/jpeg or image/png format. In addition, the image should be retrievable using CORS. |