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. -
AttributeDescription
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=offParticipant joins the room with microphone turned off.


audioDenoiser=on

audioDenoiser=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

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=offHide the room background.

bottomToolbar=on

bottomToolbar=off

Show/hide the entire bottom toolbar.

breakout=on

breakout=off

Show/hide the breakout room feature for the meeting host.

callQualityMonitoring=on

callQualityMonitoring=off

Show/hide the meeting diagnostics button, sidebar, and indicators.

The rooms top toolbar is required to use the meeting diagnostics feature.

cameraAccess=on

cameraAccess=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.

Possible values: slight-blur, blur, image-cabin, image-concrete, image-brick, image-sunrise, image-day, image-night

chat=on

chat=off

Show/hide the chat button.

chatDownload=on

chatDownload=off

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.

floatSelfFloat the self view to the bottom right.

groups=<group-names>

e.g. Orange,Banana,Coconut

Predefine up to 20 groups for the breakout groups function.

highlightActiveSpeaker=on

highlightActiveSpeaker=off

Show/hide active speaker highlighting in real-time.
lang=<code>

Set the room UI language.

Possible values: 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, Spanish es, Swedish sv, or Ukrainian uk

leaveButton=on

leaveButton=off

Show/hide the leave button.

localization=on

localization=off

Show/hide the language picker.

Hiding the localization options means the user will not be able to change their language preference.

locking=offHide the room lock button.
logo=offHide the logo in the room header.

lowData=on

lowData=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: top bar, chat, screensharing, leave button, and Whereby’s default branding.

Shown items: Video, audio, and people buttons.

moreButton=offHide the more [...] button.
participantCount=offHide the participant counter.
people=offHide the people button.
pipButton=offHide the Picture in Picture button.

precallCeremony=on

precallCeremony=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

precallReview=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

screenshare=off

Show/hide the screenshare button.
settingsButton=offHide the settings button.
skipMediaPermissionPromptSkip the 'request permissions' screen and immediately trigger the browser’s camera/microphone prompt

subgridLabels=on

subgridLabels=off

Enable name labels for participants in the subgrid.

timer=on

timer=off

Show/hide the meeting timer.
toolbarDarkTextSets button icon labels color to black.
toolbarText=on
toolbarText=off
Removes text from labels in the room toolbar.

topToolbar=on

topToolbar=off

Show/hide the entire top toolbar.
video=offParticipant 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.

+
AttributeDescription
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=offParticipant joins the room with microphone turned off.


audioDenoiser=on

audioDenoiser=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

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=offHide the room background.

bottomToolbar=on

bottomToolbar=off

Show/hide the entire bottom toolbar.

breakout=on

breakout=off

Show/hide the breakout room feature for the meeting host.

callQualityMonitoring=on

callQualityMonitoring=off

Show/hide the meeting diagnostics button, sidebar, and indicators.

The rooms top toolbar is required to use the meeting diagnostics feature.

cameraAccess=on

cameraAccess=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.

Possible values: slight-blur, blur, image-cabin, image-concrete, image-brick, image-sunrise, image-day, image-night

chat=on

chat=off

Show/hide the chat button.

chatDownload=on

chatDownload=off

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.

floatSelfFloat the self view to the bottom right.

groups=<group-names>

e.g. Orange,Banana,Coconut

Predefine up to 20 groups for the breakout groups function.

highlightActiveSpeaker=on

highlightActiveSpeaker=off

Show/hide active speaker highlighting in real-time.
lang=<code>

Set the room UI language.

Possible values: 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, Spanish es, Swedish sv, or Ukrainian uk

leaveButton=on

leaveButton=off

Show/hide the leave button.

localization=on

localization=off

Show/hide the language picker.

Hiding the localization options means the user will not be able to change their language preference.

locking=offHide the room lock button.
logo=offHide the logo in the room header.

lowData=on

lowData=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: top bar, chat, screensharing, leave button, and Whereby’s default branding.

Shown items: Video, audio, and people buttons.

moreButton=offHide the more [...] button.
participantCount=offHide the participant counter.
people=offHide the people button.
pipButton=offHide the Picture in Picture button.

precallCeremony=on

precallCeremony=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.

precallPermissionsHelpLink=<url>Specify custom help link in pre-call review step pointing users to additional support pages.

precallReview=on

precallReview=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

screenshare=off

Show/hide the screenshare button.
settingsButton=offHide the settings button.
skipMediaPermissionPromptSkip the 'request permissions' screen and immediately trigger the browser’s camera/microphone prompt

subgridLabels=on

subgridLabels=off

Enable name labels for participants in the subgrid.

timer=on

timer=off

Show/hide the meeting timer.
toolbarDarkTextSets button icon labels color to black.
toolbarText=on
toolbarText=off
Removes text from labels in the room toolbar.

topToolbar=on

topToolbar=off

Show/hide the entire top toolbar.
video=offParticipant 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.

{% hint style="success" %} There are additional room customizations and options that can be found in the [URL parameters](../whereby-for-web-browser/web-component-and-pre-built-ui/configuring-with-attributes.md) section. These options must be added as parameters on the `room` source URL, and are not currently supported as attributes directly on the component. diff --git a/whereby-101/customizing-rooms/dashboard-preferences.md b/whereby-101/customizing-rooms/dashboard-preferences.md index fd68bb4..8af016c 100644 --- a/whereby-101/customizing-rooms/dashboard-preferences.md +++ b/whereby-101/customizing-rooms/dashboard-preferences.md @@ -24,7 +24,7 @@ The device and connectivity tests are a subset of the pre-call review feature. P ### Help me fix this -You can add a custom link that appears when users accidentally block their permissions. This can be managed for all meetings via the dashboard, or set for individual meetings via our [URL parameter](using-url-parameters.md#precallpermissionhelplink-less-than-url-greater-than). If you need help building some support documentation we have some [End User Troubleshooting](../../end-user/end-user-support-guides/end-user-documentation.md) information that may prove helpful! +You can add a custom link that appears when users accidentally block their permissions. This can be managed for all meetings via the dashboard, or set for individual meetings via our [URL parameter](using-url-parameters.md#precallpermissionshelplink-less-than-url-greater-than). If you need help building some support documentation we have some [End User Troubleshooting](../../end-user/end-user-support-guides/end-user-documentation.md) information that may prove helpful!
diff --git a/whereby-product-features/dashboard-preferences/README.md b/whereby-product-features/dashboard-preferences/README.md index 2dec721..c83bbbe 100644 --- a/whereby-product-features/dashboard-preferences/README.md +++ b/whereby-product-features/dashboard-preferences/README.md @@ -38,7 +38,7 @@ The device and connectivity tests are a subset of the pre-call review feature. P #### Help me fix this -You can add a custom link that appears when users accidentally block their permissions. This can be managed for all meetings via the dashboard, or set for individual meetings via our [URL parameter](../../whereby-for-web-browser/web-component-and-pre-built-ui/configuring-with-attributes.md#precallpermissionhelplink-less-than-url-greater-than). If you need help building some support documentation we have some [End User Troubleshooting](../../end-user/end-user-support-guides/end-user-documentation.md) information that may prove helpful! +You can add a custom link that appears when users accidentally block their permissions. This can be managed for all meetings via the dashboard, or set for individual meetings via our [URL parameter](../../whereby-for-web-browser/web-component-and-pre-built-ui/configuring-with-attributes.md#precallpermissionshelplink-less-than-url-greater-than). If you need help building some support documentation we have some [End User Troubleshooting](../../end-user/end-user-support-guides/end-user-documentation.md) information that may prove helpful!