Skip to main content

DyteUIConfig

Property nameData typeRequiredUse
waitingRoomobjectNoObject containing waiting room settings to be used if enabled
waitingRoom.roomElementHTMLELementNoCustom HTML to be shown in the waiting room.
waitingRoom.showSelfbooleanNoShould the participant see their own video while in waiting room? Default: true.
controlBarbooleanNoShould the control bar (at the bottom of the meeting) be visible to the participant? Default: true.
controlBarElementsobjectNoObject containing element list from control bar to be able to customize what all controls should be visible to the participant
controlBarElements.fullscreenbooleanNoShould the button to make meeting fullscreen be visible? Default: true.
controlBarElements.sharebooleanNoShould the button to invite other participants to the meeting be visible? Default: true.
controlBarElements.screenSharebooleanNoShould the button to share screen be visible? Default: true.
controlBarElements.layoutbooleanNoShould the button to change meeting layout be visible? Default: true.
controlBarElements.chatbooleanNoShould the button to open in-meeting chat be visible? Default: true.
controlBarElements.pollsbooleanNoShould the button to display in-meeting polls be visible? Default: true.
controlBarElements.participantsbooleanNoShould the button to display participant list be visible? Default: true.
controlBarElements.pluginsbooleanNoShould the button to activate plugins in a meeting be visible? Default: true.
headerbooleanNoShould the header bar be visible to the participant? Default: true.
headerElementsobjectObject containing element list from header to be able to customize what all should be visible to the participant
headerElements.logobooleanNoShould a logo be visible in the meeting? Default: true.
headerElements.titlebooleanNoShould a title be visible in the meeting? Default: true.
headerElements.participantCountbooleanNoShould the participant count be visible in the meeting? Default: true.
headerElements.clockbooleanNoShould a timer be visible in the meeting? Default: true.
aloneHereElementbooleanNoShould an element displaying custom HTML to the participant be visible, when they are alone in / first to the meeting? Default: true.
logostring_urlNoPublicly accessible link to the logo that needs to be shown in the meeting
colorsobjectNoObject containing color values to be used as the theme for the meeting
colors.primarystring_hexColorYesColor of the primary elements like participant name box. Default: '#2160FD'.
colors.secondarystring_hexColorYesColor of the secondary elements like control bar, control buttons, hover. Default: '#262626'.
colors.textPrimarystring_hexColorYesColor of the text elements. Default: '#EEEEEE'.
colors.videoBackgroundstring_hexColorYesColor behind the video when the video is turned off. Default: '#1A1A1A'.
dimensionsobjectNoObject containing info about meeting dimensions within the container. If omitted, the meeting takes up the complete area of the root display element.
dimensions.widthnumberWith dimensions.heightDesired width of the meeting element, in pixels
dimensions.heightnumberWith dimensions.widthDesired height of the meeting element, in pixels
dimensions.modestringNoSet the mode to one of the pre-defined values - fillParent takes up entire area available to the parent container, instead of root container
gridobjectNoObject containing options to customize the meeting grid
grid.defaultViewstringNoSet the grid view to one of the view options - single shows a single participant in majority area of the meeting grid, which will be the active speaker or the pinned participant, multi shows multiple participants in the meeting grid. Default: 'multi'.
grid.multiobjectNoObject containing options for multi view meeting
grid.multi.maxVideoCountnumberNoDesired number of maximum participant video streams to be shown on a single screen. Default: 6. Maximum: 9.
grid.multi.videoFitstringNoSet the aspect ratio for fitting the video streams of participants into their container - contain maintains aspect ratio and leaves margin whereas cover fits the video to fit container size and crops if required.
grid.singleobjectNoObject containing options for single view meeting
grid.single.videoFitstringNoSet the aspect ratio for fitting the video streams of participants into their container - contain maintains aspect ratio and leaves margin whereas cover fits the video to fit container size and crops if required.