Skip to main content

i18n API

Provides API to customize and add multiple language and locale translations for all strings used across App Builder.

i18n : i18nInterface[]

Accepts an array of i18nInterface objects, each specific to a language or locale.

The overrides are applied by passing the array under the top-level i18n key to the Customization API config object.

i18nInterface

KeyTypeDescription
localestringUnique string identifier to specify a language.
label?stringLanguage name to display in the UI dropdown
datai18nDataInterfaceThe necessary translations for a given locale

i18nDataInterface

createScreenLabels

KeyTypeDescriptionDefaults
createRoomHeading?I18nBaseTypeCreate screen card heading textCreate a Room
createRoomInputLabel?I18nBaseTypeCreate screen input label textRoom Name
createRoomInputPlaceholderText?I18nBaseTypeCreate screen input placeholder textThe Annual Galactic Meet
createRoomMakeEveryOneCoHost?I18nBaseTypeCreate screen toggle 1 textMake everyone a Co-Host
createRoomMakeEveryOneCoHostTooltipText?I18nBaseTypeCreate screen toggle 1 tooltip textTurning on will give everyone the control of this room
createRoomAllowPhoneNumberJoining?I18nBaseTypeCreate screen toggle 2 textAllow joining via a phone number
createRoomAllowPhoneNumberJoiningTooltipText?I18nBaseTypeCreate screen toggle 2 tooltip textAttendees can dial a number and join via PSTN
createRoomBtnText?I18nBaseTypeCreate screen primary button textCREATE A ROOM
createRoomJoinWithID?I18nBaseTypeCreate screen secondary button textJoin with a room ID
createRoomSuccessToastHeading?I18nBaseTypeCreate screen toast heading text on successful room creation"meetingname" has been created
createRoomSuccessToastSubHeading?I18nDynamicTypeCreate screen toast subheading text on successful room creationYour New room is now live

joinScreenLabels

KeyTypeDescriptionDefaults
joinRoomHeading?I18nBaseTypeJoin screen card heading textJoin a Room
joinRoomInputLabel?I18nBaseTypeJoin screen input field labelRoom ID
joinRoomInputPlaceholderText?I18nBaseTypeJoin screen input field placeholder textEnter Room ID
joinRoomBtnText?I18nBaseTypeJoin screen primary button textJoin Room
joinRoomCreateBtnText?I18nBaseTypeJoin screen secondary button textCreate a Room
joinRoomErrorToastHeading?I18nBaseTypeJoin screen toast heading text on join errorRoom ID is Invalid
joinRoomCreateBtnText?I18nBaseTypeJoin screen toast subheading text on join errorPlease enter a valid Room ID

shareScreenLabels

KeyTypeDescriptionDefaults
shareRoomAttendeeLinkLabel?I18nBaseTypeShare screen attendee link labelAttendee Link
shareRoomAttendeeLinkSubText?I18nBaseTypeShare screen attendee link subtextShare this with attendees you want to invite.
shareRoomHostLinkLabel?I18nBaseTypeShare screen host link labelHost Link
shareRoomHostLinkSubText?I18nBaseTypeShare screen host link subtextShare this with other co-hosts you want to invite.
shareRoomPSTNLabel?I18nBaseTypeShare screen PSTN labelPSTN
shareRoomPSTNNumberLabel?I18nBaseTypeShare screen PSTN Number labelNumber
shareRoomPSTNPinLabel?I18nBaseTypeShare screen PSTN Pin labelPin
shareRoomPSTNSubText?I18nBaseTypeShare screen PSTN subtext labelShare this phone number and pin to dial from phone.
shareRoomCopyBtnTooltipText?I18nBaseTypeShare screen copy icon button tooltip textCopied to clipboard
shareRoomStartBtnText?I18nBaseTypeShare screen primary button textStart Room (as host)
shareRoomCopyBtnText?I18nBaseTypeShare screen secondary button textCopy invite to clipboard
shareRoomCopyInviteToClipboardContent?I18nBaseType<MeetingInviteInterface>Share screen room invite content-

preCallScreenLabels

KeyTypeDescriptionDefaults
precallYouAreJoiningAsHeading?I18nBaseTypePrecall Card HeadingYou are joining
precallNameInputPlaceholderText?I18nBaseTypePrecall Input Placeholder TextEnter Your Name
precallInputGettingName?I18nBaseTypePrecall Input Placeholder Text while loadingGetting name...
precallJoinBtnText?I18nBaseTypePrecall Primary Button TextJOIN ROOM

settingsPanelLabels

Settings Panel common for precall screen and video call screen

KeyTypeDescriptionDefaults
settingsPanelHeading?I18nBaseTypeSettings Panel Heading TextSettings
settingsPanelCameraLabel?I18nBaseTypeSettings Panel Camera Dropdown LabelCamera
settingsPanelNoCameraDetectedText?I18nBaseTypeSettings Panel Camera Dropdown Label when no camera is detectedNo Camera Detected
settingsPanelNoCameraSelectedText?I18nBaseTypeSettings Panel Camera Dropdown Label when no camera is selectedNo Camera Selected
settingsPanelMicrophoneLabel?I18nBaseTypeSettings Panel Microphone Dropdown LabelMicrophone
settingsPanelNoMicrophoneDetectedText?I18nBaseTypeSettings Panel Microphone Dropdown Label when no microphone is detectedNo Microphone Detected
settingsPanelNoMicrophoneSelectedText?I18nBaseTypeSettings Panel Microphone Dropdown Label when no microphone is selectedNo Microphone Selected
settingsPanelSpeakerLabel?I18nBaseTypeSettings Panel Speaker Dropdown LabelSpeaker
settingsPanelNoSpeakerDetectedText?I18nBaseTypeSettings Panel Speaker Dropdown Label when no speaker is detectedNo Speaker Detected
settingsPanelNoSpeakerSelectedText?I18nBaseTypeSettings Panel Speaker Dropdown Label when no speaker is selectedNo Speaker Selected
settingsPanelSystemDefaultSpeakerText?I18nBaseTypeSettings Panel Speaker Dropdown Default Value TextSystem Default Speaker Device
settingsPanelUpdatingText?I18nBaseTypeSettings Panel Dropdown Updating TextUpdating...
settingsPanelLiveStreamingAttendeeInfo?I18nBaseTypeSettings Panel Info Text for livestreaming attendee user(only applicable on video call screen)Attendees need to raise their hand to access the devices.
settingsPanelLanguageLabel?I18nBaseTypeSettings Panel Language Dropdown Label (only applicable on video call screen)Language
settingPanelNameCantbeChangedInfo?I18nBaseTypeSettings Panel Info Text When Whiteboard is active (only applicable on video call screen)Name can't be changed while whiteboard is active
settingPanelNameInputLabel?I18nBaseTypeSettings Panel Name Input Field Label (only applicable on video call screen)Your Name

virtualBackgroundPanelLabels

VirtualBackground Panel Labels common for precall screen and video call screen

KeyTypeDescriptionDefaults
vbPanelHeading?I18nBaseTypeVirtual Background Panel Heading TextVirtual Background
vbPanelInfo?I18nConditionalTypeVirtual Background Panel Info Text When Camera Switch On or OffCamera is currently off. Selected background will be applied as soon as your camera turns on.
vbPanelOptionNoneText?I18nBaseTypeVirtual Background Panel Option text to remove effectNone
vbPanelOptionBlurText?I18nBaseTypeVirtual Background Panel Option text to add blur effectBlur
vbPanelOptionCustomText?I18nBaseTypeVirtual Background Panel Option text to add custom effectCustom
vbPanelAppliedBtnText?I18nBaseTypeVirtual Background Panel Apply Button Text(Only applicable to video call screen) ApplyApply
vbPanelApplyBtnText?I18nBaseTypeVirtual Background Panel Applied Button Text(Only applicable to video)Applied
vbPanelImageUploadErrorToastHeading?I18nBaseTypeVirtual Background Panel Error Toast Heading On Image upload failedUpload Failed
vbPanelImageUploadErrorToastSubHeading?I18nBaseTypeVirtual Background Panel Error Toast Subheading On Image upload failedSelected image is already uploaded
vbPanelImageTypeErrorToastHeading?I18nBaseTypeVirtual Background Panel Error Toast Heading On Invalid file typeUpload Failed
vbPanelImageTypeErrorToastSubHeading?I18nBaseTypeVirtual Background Panel Error Toast Subheading On Invalid file typePlease select a JPG or PNG file
vbPanelImageSizeLimitErrorToastHeading?I18nBaseTypeVirtual Background Panel Error Toast Heading On File Size LimitationUpload Failed
vbPanelImageSizeLimitErrorToastSubHeading?I18nBaseTypeVirtual Background Panel Error Toast Subheading On File Size LimitationFile size must be less than 1MB.

videoCallScreenLabels

toolbarItemLabels

KeyTypeDescriptionDefaults
toolbarItemPeopleText?I18nBaseTypePeople ToolbarItem LabelPeople
toolbarItemChatText?I18nBaseTypeChat ToolbarItem LabelChat
toolbarItemSettingText?I18nBaseTypeSettings ToolbarItem LabelSettings
toolbarItemLayoutText?I18nBaseTypeLayout ToolbarItem LabelLayout
toolbarItemLayoutOptionGridText?I18nBaseTypeLayout ToolbarItem Option Grid LabelGrid
toolbarItemLayoutOptionSidebarText?I18nBaseTypeLayout ToolbarItem Option Sidebar LabelSidebar
toolbarItemInviteText?I18nBaseTypeInvite ToolbarItem LabelInvite
toolbarItemMicrophoneText?I18nBaseTypeMicrophone ToolbarItem LabelMic On
toolbarItemMicrophoneTooltipText?I18nBaseTypeMicrophone ToolbarItem Tooltip LabelDisable Mic
toolbarItemCameraText?I18nBaseTypeCamera ToolbarItem LabelVideo On
toolbarItemCameraTooltipText?I18nBaseTypeCamera ToolbarItem Tooltip LabelDisable Video
toolbarItemShareText?I18nBaseTypeShare ToolbarItem Tooltip LabelShare
toolbarItemRecordingText?I18nBaseTypeRecording ToolbarItem Tooltip LabelRecord
toolbarItemLeaveText?I18nBaseTypeLeave ToolbarItem Tooltip LabelLeave
toolbarItemMoreText?I18nBaseTypeMore ToolbarItem Tooltip LabelMore
toolbarItemNoiseCancellationText?I18nBaseTypeNoise Cancellation ToolbarItem Tooltip LabelNoise Cancellation
toolbarItemVitrualBackgroundText?I18nBaseTypeVirtual Background ToolbarItem Tooltip LabelVirtual Background
toolbarItemWhiteboardText?I18nBaseTypeWhiteboard ToolbarItem Tooltip LabelShow Whiteboard
toolbarItemCaptionText?I18nBaseTypeCaption ToolbarItem Tooltip LabelShow Caption
toolbarItemTranscriptText?I18nBaseTypeTranscript ToolbarItem Tooltip LabelShow Transcript
toolbarItemRaiseHandText?I18nBaseTypeRaise Hand ToolbarItem Tooltip Label (Only applicable to Livestreaming vertical)Raise Hand
livestreamingMicrophoneTooltipText?I18nConditionalTypeLivestreaming microphone Tooltip text (Only applicable to Livestreaming vertical)Raise Hand in order to turn mic on
livestreamingCameraTooltipText?I18nConditionalTypeLivestreaming camera Tooltip text (Only applicable to Livestreaming vertical)Raise Hand in order to turn video on
livestreamingShareTooltipText?I18nConditionalTypeLivestreaming share Tooltip text (Only applicable to Livestreaming vertical)Raise Hand in order to present
videoRoomPeopleCountTooltipHostText?I18nBaseTypeLivestreaming people count tooltip host textHost
videoRoomPeopleCountTooltipAttendeeText?I18nBaseTypeLivestreaming people count tooltip audience textAudience

popupLabels

KeyTypeDescriptionDefaults
permissionPopupHeading?I18nBaseTypePermission Helper Popup HedingAllow access to camera and microphone
permissionPopupSubHeading?I18nBaseTypePermission Helper Popup SubheadingSelect “Allow” for others to see and hear you
permissionPopupDismissBtnText?I18nBaseTypePermission Helper Dismiss Button textDismiss
permissionPopupErrorToastHeading?I18nBaseTypeError Toast Heading TextCan't find your Camera
permissionPopupErrorToastSubHeading?I18nBaseTypeError Toast SubHeading TextCheck your system settings to make sure that a camera is available. If not, plug one in and restart your browser
invitePopupHeading?I18nBaseTypeInvite Popup Heading TextInvite others to join this room
invitePopupPrimaryBtnText?I18nBaseTypeInvite Popup Primary Button TextCOPY INVITATION
stopRecordingPopupHeading?I18nBaseTypeStop Recording Popup Heading TextStop Recording?
stopRecordingPopupSubHeading?I18nBaseTypeStop Recording Popup Subheading TextAre you sure you want to stop recording? You can’t undo this action.
stopRecordingPopupPrimaryBtnText?I18nBaseTypeStop Recording Popup Primary Button TextEND RECORDING
leavePopupHeading?I18nBaseTypeLeave Popup Heading TextLeave Room?
leavePopupSubHeading?I18nConditionalTypeLeave Popup Subheading TextAre you sure you want to leave this room?
leavePopupPrimaryBtnText?I18nBaseTypeLeave Popup Primary Button TextLEAVE
removeUserFromRoomPopupHeading?I18nDynamicTypeRemove User From Room Popup Heading TextRemove "username"?
removeUserFromRoomPopupSubHeading?I18nDynamicTypeRemove User From Room Popup Subheading TextOnce removed, "username" will still be able to rejoin the room later.
removeUserFromRoomPopupPrimaryBtnText?I18nBaseTypeRemove User From Room Popup Primary ButtonTextREMOVE
removeScreenshareFromRoomPopupHeading?I18nBaseTypeRemove Screenshare From Room Popup Heading TextRemove Screenshare?
removeScreenshareFromRoomPopupSubHeading?I18nDynamicTypeRemove Screenshare From Room Popup Subheading TextOnce removed, "screenshare name" will still be able to screen share later.
removeScreenshareFromRoomPopupPrimaryBtnText?I18nBaseTypeRemove Screenshare From Room Popup Primary Button TextREMOVE
clearAllWhiteboardPopupHeading?I18nBaseTypeWhiteboard Clear All Popup Heading TextClear Whiteboard?
clearAllWhiteboardPopupSubHeading?I18nBaseTypeWhiteboard Clear All Popup Subheading TextAre you sure you want to clear the whiteboard?
clearAllWhiteboardPopupPrimaryBtnText?I18nBaseTypeWhiteboard Clean All Popup Primary Button TextCLEAR ALL
nativeScreensharePopupHeading?I18nBaseTypeNative Screenshare Popup Heading TextScreen Share
nativeScreensharePopupSubHeading?I18nConditionalTypeNative Screenshare Popup Subheading TextNOTE: Camera and all incoming videos will be turned OFF for an optimised performance, do you wish to proceed?
nativeScreensharePopupPrimaryBtnText?I18nBaseTypeNative Screenshare Popup Primary Button TextPROCEED
nativeScreensharePopupIncludeDeviceAudioText?I18nBaseTypeNative Screenshare Popup Primary Button TextInclude device audio
nativeStopScreensharePopupHeading?I18nBaseTypeNative Stop Screenshare Popup Heading TextStop Screen Share?
nativeStopScreensharePopupSubHeading?I18nBaseTypeNative Stop Screenshare Popup Subheading TextYou need to stop sharing your screen in order to turn the camera ON
nativeStopScreensharePopupPrimaryBtnText?I18nBaseTypeNative Stop Screenshare Popup Primary Button TextSTOP SHARE & TURN CAMERA ON
sttChangeLanguagePopupHeading?I18nConditionalTypeChange Spoken Language Popup Heading TextSet Spoken Language
sttChangeLanguagePopupSubHeading?I18nBaseTypeChange Spoken Language Popup Subheading TextWhat language(s) are being spoken by everyone in this room?
sttChangeLanguagePopupPrimaryBtnText?I18nBaseTypeChange Spoken Language Popup Primary Button TextCONFIRM
sttChangeLanguagePopupDropdownInfo?I18nBaseTypeChange Spoken Language Popup Dropdown Info TextYou can choose a maximum of two languages
sttChangeLanguagePopupDropdownError?I18nBaseTypeChange Spoken Language Popup Dropdown Error TextChoose at least one language to proceed
muteAllConfirmationPopoverContent?I18nBaseTypeMute all popover textMute everyone's video/audio on the call?
requestConfirmationPopoverContent?I18nBaseTypeRequest video/audio popover textRequest "username" to turn on their microphone/camera
muteConfirmationPopoverContent?I18nBaseTypeMute video/audio popover textMute "username" audio/video for everyone on the call? Only "username" can unmute themselves
muteAllConfirmationPopoverPrimaryBtnText?I18nBaseTypeMute all popover primary button textMute All
muteConfirmationPopoverPrimaryBtnText?I18nBaseTypeMute popover primary button textMute
requestConfirmationPopoverPrimaryBtnText?I18nBaseTypeRequest popover primary button textRequest

videoRoomLabels

KeyTypeDescriptionDefaults
videoTileNetworkQuailtyLabel?I18nBaseType<NetworkQualities>Network Quality Indicator LabelLoading / Network Loading / Network Unpublished / Very Bad Network / Bad Network / Bad Network / Excellent Network / Network Unsupported
moreBtnViewWhiteboard?I18nBaseTypeUsed in video tile/participant more buttonView Whiteboard
moreBtnRemoveFromLarge?I18nBaseTypeUsed in video tile/participant more buttonRemove From Large
moreBtnViewInLarge?I18nBaseTypeUsed in video tile/participant more buttonView In Large
moreBtnPinToTop?I18nBaseTypeUsed in video tile/participant more buttonPin to top
moreBtnRemoveFromTop?I18nBaseTypeUsed in video tile/participant more buttonRemove from top
moreBtnMessagePrivately?I18nBaseTypeUsed in video tile/participant more buttonMessage Privately
moreBtnAudio?I18nConditionalTypeUsed in video tile/participant more buttonMute Audio
moreBtnVideo?I18nConditionalTypeUsed in video tile/participant more buttonMute Video
moreBtnAddAsPresenter?I18nBaseTypeUsed in video tile/participant more buttonAdd as Presenter
moreBtnRemoveAsPresenter?I18nBaseTypeUsed in video tile/participant more buttonRemove as Presenter
moreBtnRemoveFromRoom?I18nBaseTypeUsed in video tile/participant more buttonRemove from Room
moreBtnChangeName?I18nBaseTypeUsed in video tile/participant more buttonChange Name
moreBtnStopScreenShare?I18nBaseTypeUsed in video tile/participant more buttonStop Screenshare
moreBtnRemoveScreenShare?I18nBaseTypeUsed in video tile/participant more buttonRemove Screenshare
videoRoomUserFallbackText?I18nBaseTypeUsername fallback textUser
videoRoomRecordingText?I18nBaseTypeUsed in top toolbar for recording statusRecording
videoRoomGoToActiveSpeakerText?I18nBaseTypeUsed in Sidebar layoutGo To Active Speaker
videoRoomStartingCallText?I18nBaseTypeUsed in video call screen loadingStarting Call. Just a second.
videoRoomScreenshareText?I18nDynamicTypeUsed in screen share tile username"username"'s screenshare
videoRoomScreenshareOverlayText?I18nBaseTypeUsed in screen share tileYou are sharing your screen
videoRoomScreenshareStopSharingBtnText?I18nBaseTypeUsed in screen share tileStop Sharing
livestreamingAttendeeWhatYouCanDoText?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinHere's what you can do here :
livestreamingAttendeeInviteOthersText?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinINVITE OTHER ATTENDEES
livestreamingAttendeeWaitingForHostToJoinText?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinWaiting for the host to join
livestreamingAttendeeRaiseHandInfoHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinRaise Your hand
livestreamingAttendeeRaiseHandInfoSubHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinLet everyone know that you've something to say
livestreamingAttendeeChatWithOthersInfoHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinChat with others
livestreamingAttendeeChatWithOthersInfoSubHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinMessage fellow attendees or the hosts
livestreamingAttendeePresentYourScreenInfoHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinPresent Your screen
livestreamingAttendeePresentYourScreenInfoSubHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinBe a presenter post the host’s approval
livestreamingAttendeeJoinWithActivitiesInfoHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinJoin in activities
livestreamingAttendeeJoinWithActivitiesInfoSubHeading?I18nBaseTypeUsed in livestreaming attendee info tile while waiting for host to joinJam with everyone on a whiteboard

STTLabels

KeyTypeDescriptionDefaults
sttChangeSpokenLanguageText?I18nBaseTypeSTT More Button TextChange Spoken Language
sttTranscriptPanelHeaderText?I18nBaseTypeTranscript Panel Header TextRoom Transcript
sttDownloadBtnText?I18nBaseTypeLeave Call Popup Download Button TextDownload
sttDownloadTranscriptBtnText?I18nBaseTypeTranscript Panel Download Button TextDownload Transcript
sttSettingSpokenLanguageText?I18nBaseTypeUsed in Caption panel while setting the spoken languageSetting Spoken Language
sttLanguageChangeInProgress?I18nBaseTypeUsed in Caption panel while changing the spoken languageLanguage Change is in progress...
sttTranscriptPanelSearchText?I18nBaseTypeUsed in Transcript panel search input placeholderSearch
sttTranscriptPanelNoSearchResultsFoundText?I18nBaseTypeUsed in Transcript panel search containerNo search results found
sttTranscriptPanelViewLatestText?I18nBaseTypeUsed in Transcript panel when new translation availableView Latest

peoplePanelLabels

KeyTypeDescriptionDefaults
peoplePanelHeaderText?I18nBaseTypePeople panel header textPeople
peoplePanelTurnoffAllCameraBtnText?I18nBaseTypePeople panel Host Control Turn off all camera button textTurn off all cameras
peoplePanelMuteAllMicBtnText?I18nBaseTypePeople panel Host Control Mute all button textMute All
peoplePanelHostSectionHeaderText?I18nBaseTypePeople panel Host Section header textHOST
peoplePanelAudienceSectionHeaderText?I18nBaseTypePeople panel Audience Section Header textAUDIENCE
peoplePanelInThisMeetingLabel?I18nBaseTypePeople panel In this Room section Header textIN THIS MEETING
peoplePanelNoHostJoinedContent?I18nBaseTypePeople panel Placeholder text when no host joinedNo Host has joined yet.
peoplePanelNoAudienceJoinedContent?I18nBaseTypePeople panel Placeholder text when no audience joinedNo Audience has joined yet.
peoplePanelNoUsersJoinedContent?I18nBaseTypePeople panel Placeholder text when no user joinedNo Users has joined yet.
peoplePanelWantToJoinText?I18nBaseTypePeople panel Want to join Section Header textWANT TO JOIN
peoplePanelWaitingText?I18nBaseTypePeople panel Waiting Section header textWAITING
peoplePanelMeText?I18nBaseTypePeople panel local user indicator textMe
peoplePanelPresenterText?I18nBaseTypePeople panel presenter user indicator textPresenter
peoplePanelWaitingRoomRequestApprovalBtnTxt?I18nBaseTypePeople panel Waiting room approval button textAdmin
peoplePanelWaitingRoomRequestDenyBtnTxt?I18nBaseTypePeople panel Waiting room deny button textDeny
peoplePanelUserNotFoundLabel?I18nBaseTypePeople panel User is missingUser not found
peoplePanelStreamingRequestSectionHeader?I18nBaseTypePeople panel Streaming Request section headerSTREAMING REQUEST
peoplePanelLivestreamingApprovalBtnText?I18nBaseTypePeople panel Livestreaming approval button textAccept
peoplePanelLivestreamingDenyBtnText?I18nBaseTypePeople panel Livestreaming deny button textDeny

chatPanelLabels

KeyTypeDescriptionDefaults
chatPanelGroupTabText?I18nBaseTypeChat Panel Group tab button textGroup
chatPanelPrivateTabText?I18nBaseTypeChat Panel Private tab button textPrivate
chatPanelUserOfflineText?I18nBaseTypeChat Panel User offline message textUser is offline
chatPanelUnreadMessageText?I18nBaseTypeChat Panel Welcome contentUnread message
groupChatWelcomeContent?I18nConditionalTypeChat Panel unread message textWelcome to Chat! All messages are deleted when call ends.
groupChatInputPlaceHolderText?I18nDynamicTypeChat Panel unread message textChat publicly as "username"...
privateChatInputPlaceHolderText?I18nDynamicTypeChat Panel unread message textPrivate Message to "username"

toastLabels

KeyTypeDescriptionDefaults
userRemovedFromTheRoomToastHeading?I18nDynamicToast heading to inform the host when he remove someone from the callThe system will remove "username" from this call after 5 secs.
sttSpokenLanguageToastHeading?[I18nBaseType]<sttSpokenLanguageToastHeadingDataType>Toast heading to inform users when spoken language is changedSpoken Language Set
sttSpokenLanguageToastSubHeading?[I18nBaseType]<[sttSpokenLanguageToastSubHeadingDataInterface]>(#sttspokenlanguagetoastsubheadingdatainterface)Toast subheading to inform users when spokne language is changed"username" has set the spoken language to "english"
waitingRoomApprovalRequiredToastHeading?I18nBaseTypeToast heading to inform the host when he someone requested waiting room approvalApproval Required
waitingRoomApprovalRequiredToastSubHeading?I18nDynamicToast heading to informthe host when he someone requested waiting room approval"username" is waiting for approval to join the call
waitingRoomApprovalRequiredPrimaryBtnText?I18nBaseTypeToast primary button textAdmit
waitingRoomApprovalRequiredSecondaryBtnText?I18nBaseTypeToast secondary button textDeny
waitingRoomApprovalRejectionToastHeading?I18nBaseTypeToast heading to inform the user when he host rejected the waiting room requestApproval Required
waitingRoomApprovalRejectionToastSubHeading?I18nBaseTypeToast subheading to inform the user when he host rejected the waiting room requestPermission to enter the room was denied by the host
publicChatToastHeading?I18nDynamicTypeUsed when somebody receive message in public chat"username" commented in the public chat
multiplePublicChatToastHeading?I18nBaseTypeUsed when 2 or more people receives message in public chatNew comments in Public Chat
multiplePublicChatToastSubHeading?I18nBaseType<publicChatToastSubHeadingDataInterface>Used when 2 or more people receives message in public chatYou have "5" new messages from "username1,username2"
privateChatToastHeading?I18nBaseTypeUsed when user received single private messageYou’ve received a private message
multiplePrivateChatToastHeading?I18nBaseType<privateChatToastHeadingDataInterface>Used when user received mutliple private messageYou’ve received "2" private messages
multiplePublicAndPrivateChatToastHeading?I18nBaseTypeUsed when user received multiple public and private messageNew comments in Public & Private Chat
multiplePublicAndPrivateChatToastSubHeading?I18nBaseType<publicAndPrivateChatToastSubHeadingDataInterface>Used when user received multiple public and private messageYou have "2" new messages from "user1,user2" and "5" Private chat
hostMutedUserToastHeading?I18nBaseType<I18nMuteType>Used when host mute user video/audioThe host has muted your video/audio
hostRequestedUserToastHeading?I18nBaseType<I18nMuteType>Used when host request user video/audioThe host has requested you to speak/The host has asked you to start your video
hostRequestedUserToastPrimaryBtnText?I18nBaseType<I18nMuteType>Used when host request user video/audio primary action button textUNMUTE
hostRequestedUserToastSecondaryBtnText?I18nBaseType<I18nMuteType>Used when host request user video/audio secondary action button textLATER
hostRemovedUserToastHeading?I18nBaseTypeToast heading when host removed user from the callThe host has removed you from the room.
deviceDetectionToastHeading?I18nDynamicTypeToast heading when user connect a new device into the systemNew Mic detected
deviceDetectionToastSubHeading?I18nBaseType<deviceDetectionToastSubHeadingDataInterface>Toast subheading when user connect a new device into the systemNew UserDeviceName named mic detected. Do you want to switch?
deviceDetectionPrimaryBtnText?I18nBaseTypePrimary Button TextSWITCH DEVICE
deviceDetectionSecondaryBtnText?I18nBaseTypeSecondary Button textIGNORE
deviceDetectionCheckboxText?I18nBaseTypeCheckbox label textRemember my choice
whiteboardExportErrorToastHeading?I18nBaseTypeWhiteboard Export Error Toast Heading TextFailed to export the whiteboard
whiteboardExportInfoToastHeading?I18nBaseTypeWhiteboard Export Info Toast Heading TextPlease wait few seconds to get the screenshot link of the whiteboard
whiteboardExportSuccessToastHeading?I18nBaseTypeWhiteboard Export Success Toast Heading TextWhiteboard exported as an image. Link copied to your clipboard.
whiteboardFileUploadErrorToastHeading?I18nBaseType<[whiteboardFileUploadToastDataType]>(#whiteboardfileuploadtoastdatatype)Whiteboard File Upload Error Toast Heading TextError on uploading "File/Image", please try again
whiteboardFileUploadInfoToastHeading?I18nBaseType<[whiteboardFileUploadToastDataType]>(#whiteboardfileuploadtoastdatatype)Whiteboard File Upload Info Toast Heading Text"File/Image" Upload will take few seconds to appear in whiteboard1
whiteboardFileUploadTypeErrorToastHeading?I18nBaseType<[whiteboardFileUploadToastDataType]>(#whiteboardfileuploadtoastdatatype)Whiteboard File Upload Type Error Toast Heading TextUnsupported file
whiteboardFileUploadTypeErrorToastSubHeading?I18nBaseType<[whiteboardFileUploadToastDataType]>(#whiteboardfileuploadtoastdatatype)Whiteboard File Upload Type Error Toast SubHeading TextPlease select file format with pdf, doc, docx, ppt, pptx, png, jpg, jpeg
videoRoomScreenShareErrorToastHeading?I18nBaseTypeScreenshare Error Toast Heading TextFailed to initiate screen sharing
videoRoomScreenShareErrorToastSubHeading?I18nBaseTypeScreenshare Error Toast SubHeading TextPermission denied
videoRoomRecordingToastHeading?I18nConditionalTypeRecording Started/Stopped Toast Heading TextRecording "Started/Stopped"
videoRoomRecordingToastSubHeading?I18nDynamicRecording Started Toast SubHeading TextThis room is being recorded by "username"
livestreamRaiseHandRequestToastHeading?I18nBaseTypeRaise Hand Requested Toast Heading Text (Audience side)You’ve raised your hand.
livestreamRaiseHandRequestToastSubHeading?I18nBaseTypeRaise Hand Requested Toast SubHeading Text (Audience side)Waiting for host to approve the request
livestreamRaiseHandRequestReceivedToastHeading?I18nDynamicRaise Hand Request Received Toast Heading Text (Host side)"username" has raised their hand to be a Presenter
livestreamRaiseHandRequestReceivedToastSubHeading?I18nBaseTypeRaise Hand Request Received Toast SubHeading Text (Audience side)Once approved they will be able to speak, share their video and present during this call.
livestreamRaiseHandRequestAcceptedToastHeading?I18nBaseTypeRaise Hand Request Accepted Toast Heading Text (Audience side)Host has approved your request.
livestreamRaiseHandRequestAcceptedToastSubHeading?I18nBaseTypeRaise Hand Request Accepted Toast SubHeading Text (Audience side)You are now a Presenter
livestreamRaiseHandRequestRejectedToastHeading?I18nBaseTypeRaise Hand Request Rejected Toast SubHeading Text (Audience side)Your request was rejected by the host
livestreamRaiseHandRequestRecallToastHeading?I18nConditionalTypeRaise Hand Request Withdraw Toast Heading Text (Host side)"username" has lowered their hand
livestreamRaiseHandRequestRecallLocalToastHeading?I18nBaseTypeRaise Hand Request Withdraw Toast Heading Text (Audience side)You’ve lowered your hand.
livestreamRaiseHandApprovedRequestRecallToastHeading?I18nBaseTypeRaise Hand Revoked Toast Heading TextHost has revoked streaming permissions.
livestreamPromoteAsCoHostToastHeading?I18nBaseTypeRaise Hand PromoteAsCoHost Toast Heading TextHost promoted you as a Presenter
livestreamRequestAlreadyProcessed?I18nBaseTypeRaise Hand Already ProcessedRequest already processed.
livestreamToastApprovalBtnText?I18nBaseTypeRaise Hand Approval Toast Primary Button textALLOW TO BE A PRESENTER
livestreamToastDenyBtnText?I18nBaseTypeRaise Hand Approval Toast Secondary Button textDENY

whiteboardLabels

KeyTypeDescriptionDefaults
whiteboardInitializingText?I18nBaseTypeWhiteboard Loading TextWhiteboard is initializing
whiteboardWidgetViewOnlyText?I18nBaseTypeView Only Button TextView Only
whiteboardWidgetZoomInText?I18nBaseTypeZoom In Button TextZoom In
whiteboardWidgetZoomOutText?I18nBaseTypeZoom Out Button TextZoom Out
whiteboardWidgetFitToScreenText?I18nBaseTypeFit To Screen Button TextFit to Screen
whiteboardWidgetRedoText?I18nBaseTypeRedo Button TextRedo
whiteboardWidgetUndoText?I18nBaseTypeUndo Button TextUndo
whiteboardWidgetExportToCloudText?I18nBaseTypeExport to Cloud Button TextExport to Cloud
whiteboardToolboxSelectText?I18nBaseTypeSelect Button TextSelect
whiteboardToolboxTextFormatting?I18nBaseTypeText Button TextText
whiteboardToolboxMoveText?I18nBaseTypeMove Button TextMove
whiteboardToolboxLaserText?I18nBaseTypeLaser Button TextLaser
whiteboardToolboxEraseText?I18nBaseTypeEraser Button TextEraser
whiteboardToolboxUploadText?I18nBaseTypeUpload Documet or Image Button TextUpload Documet or Image
whiteboardToolboxClearAllText?I18nBaseTypeClear All Button TextClear All
whiteboardToolboxWidthLabel?I18nBaseTypePencil size width TextWidth
whiteboardToolboxPxLabel?I18nBaseTypePencil size pixel Textpx

commonLabels

KeyTypeDescriptionDefaults
cancelText?I18nBaseTypeCancel Button TextCANCEL
loadingText?I18nBaseTypeLoading TextLoading...

authLabels

KeyTypeDescriptionDefaults
logoutText?I18nBaseTypeLogout Button TextLogout
authLogoutPopupHeading?I18nBaseTypeLogout Popup Heading TextLogout?
authLogoutPopupSubHeading?I18nBaseTypeLogout Popup Subheading TextAre you sure you wanna log out?
authLogoutPopupPrimaryBtnText?I18nBaseTypeLogout Popup Primary Button TextCONFIRM
authLogInRequiredPopupHeading?I18nBaseTypeLogin Required Popup Heading TextLogin Required
authLogInRequiredPopupSubHeading?I18nBaseTypeLogin Required Popup Subheading TextLog-in to your organization to continue
authLogInRequiredPopupPrimaryBtnText?I18nBaseTypeLogin Required Popup Primary Button TextLOGIN
authLogInRequiredPopupSecondaryBtnText?I18nBaseTypeLogin Required Popup Secondary ButtonTextCLOSE APP

App Builder ships with en-us out of the Box. Providing an object with en-us as it's locale will replace the default strings

When there are two or more translations in the App(including the default en-us), A dropdown language selector will be display in both the precall screen as well as the settings panel.


Usage:

Use the example code given below showcasing overriding



TYPES


I18nBaseType<T> : string | ((template: T) => string)

I18nDynamicType : I18nBaseType<string>

I18nConditionalType : I18nBaseType<boolean>

PrecallJoinBtnTextInterface

KeyTypeDescription
readybooleanBoolean that indicates whether a room is ready to be joined
roleClientRoleRole of the user trying to join
waitingRoombooleanBoolean that indicates whether a waiting room is enabled or not

MeetingInviteInterface

KeyTypeDescription
meetingNamestringName of the room
id{ host?: string; attendee?: string }Host and Attendee Room ID - Used to join via mobile
url{ host?: string; attendee?: string }Host and Attendee Room Link - Used to join via web
pstn{ number: string; pin: string }Dial in Number and Pin
isHoststringTo confirm whether the current user is host or not
isSeparateHostLinkbooleanTo confirm host and attendee will have separate link to join

ClientRole

IndexNameDescription
1BroadcasterUser publishes to other channel broadcasters and Audience members
2AudienceUser subscribing to other channel broadcasters without publishes

deviceDetectionToastSubHeadingDataInterface

KeyTypeDescription
namestringdevice type - mic/speaker/video
labelstringdevice name

I18nMuteType

enum I18nMuteType { audio = 'audio', video = 'video' }

NetworkQualities

interface NetworkQualityStatusInterface {
unknown?: 'Unknown';
excellent?: 'Excellent';
good?: 'Good';
bad?: 'Bad';
veryBad?: 'Very Bad';
unpublished?: 'Unpublished';
loading?: 'Loading';
}

type NetworkQualities = keyof NetworkQualityStatusInterface

publicChatToastSubHeadingDataInterface

KeyTypeDescription
countnumberno of unread messages from public chat
fromstringpeople name who sent those message

privateChatToastHeadingDataInterface

KeyTypeDescription
countnumberno of unread messages from private chat

publicAndPrivateChatToastSubHeadingDataInterface

KeyTypeDescription
privateChatCountnumberno of unread messages from private chat
fromstringpeople name who sent those message

sttSpokenLanguageToastHeadingDataType

 sttSpokenLanguageToastHeadingDataType = 'Set' | 'Changed'

sttSpokenLanguageToastSubHeadingDataInterface

KeyTypeDescription
actionsttSpokenLanguageToastHeadingDataTypeSpoken language set/changed
newLanguagestringnew language selected in the dropdown
oldLanguagestringold language used for transcript
usernamestringPerson name who set/change spoken language