# Digital Samba Embedded ## Reference docs - [Introduction](https://docs.digitalsamba.com/reference/introduction.md): Digital Samba Embedded is a platform which empowers integrators - [SDK](https://docs.digitalsamba.com/reference/sdk.md) - [DigitalSambaEmbedded class](https://docs.digitalsamba.com/reference/sdk/digitalsambaembedded-class.md) - [Methods](https://docs.digitalsamba.com/reference/sdk/methods.md) - [addCustomTile()](https://docs.digitalsamba.com/reference/sdk/methods/addcustomtile.md): addCustomTile({name: string, html: string, position: string "first"|"last"}) - [removeCustomTile()](https://docs.digitalsamba.com/reference/sdk/methods/removecustomtile.md): removeCustomTile(name: string) - [addFrameEventListener()](https://docs.digitalsamba.com/reference/sdk/methods/addframeeventlistener.md): addFrameEventListener(eventName, target, listener) - [addImageToWhiteboard()](https://docs.digitalsamba.com/reference/sdk/methods/addimagetowhiteboard.md): addImageToWhiteboard(options?: AddImageToWhiteboardOptions) - [addTileAction()](https://docs.digitalsamba.com/reference/sdk/methods/addtileaction.md): addTileAction(name: string, properties: TileActionProperties, listener: function) - [addUICallback()](https://docs.digitalsamba.com/reference/sdk/methods/adduicallback.md): addUICallback(event: string, callback: function) - [allowBroadcast()](https://docs.digitalsamba.com/reference/sdk/methods/allowbroadcast.md): allowBroadcast({id: string, audio?: boolean, video?: boolean) allowBroadcast(userId: string) - legacy - [allowScreenshare()](https://docs.digitalsamba.com/reference/sdk/methods/allowscreenshare.md): allowScreenshare(userId: string) - [changeBrandingOptions()](https://docs.digitalsamba.com/reference/sdk/methods/changebrandingoptions.md): changeBrandingOptions({paletteMode, primaryColor, toolbarColor, roomBackgroundColor}) - [changeLayoutMode()](https://docs.digitalsamba.com/reference/sdk/methods/changelayoutmode.md): changeLayoutMode(mode: 'tiled' | 'auto') - [changeRole()](https://docs.digitalsamba.com/reference/sdk/methods/changerole.md): changeRole(userId: string, role: string) - [changeToolbarPosition()](https://docs.digitalsamba.com/reference/sdk/methods/changetoolbarposition.md): changeToolbarPosition(side: 'left' | 'bottom' | 'right') - [closeLibraryFile()](https://docs.digitalsamba.com/reference/sdk/methods/closelibraryfile.md): closeLibraryFile(id?: string) - [closeWhiteboard()](https://docs.digitalsamba.com/reference/sdk/methods/closewhiteboard.md): closeWhiteboard(id?: string) - [createWhiteboard()](https://docs.digitalsamba.com/reference/sdk/methods/createwhiteboard.md): createWhiteboard: ({personal: boolean, folderId: string}) - [configureCaptions()](https://docs.digitalsamba.com/reference/sdk/methods/configurecaptions.md): configureCaptions({ fontSize, spokenLanguage }) - [configureVirtualBackground()](https://docs.digitalsamba.com/reference/sdk/methods/configurevirtualbackground.md): configureVirtualBackground(options: VirtualBackgroundOptions) - [disableAudio()](https://docs.digitalsamba.com/reference/sdk/methods/disableaudio.md) - [disableVideo()](https://docs.digitalsamba.com/reference/sdk/methods/disablevideo.md) - [disableVirtualBackground()](https://docs.digitalsamba.com/reference/sdk/methods/disablevirtualbackground.md) - [disallowBroadcast()](https://docs.digitalsamba.com/reference/sdk/methods/disallowbroadcast.md): disallowBroadcast(userId: string) - [disallowScreenshare()](https://docs.digitalsamba.com/reference/sdk/methods/disallowscreenshare.md): disallowScreenshare(userId: string) - [enableAudio()](https://docs.digitalsamba.com/reference/sdk/methods/enableaudio.md) - [enableVideo()](https://docs.digitalsamba.com/reference/sdk/methods/enablevideo.md) - [enableVirtualBackground()](https://docs.digitalsamba.com/reference/sdk/methods/enablevirtualbackground.md): enableVirtualBackground(options: VirtualBackgroundOptions) - [endSession()](https://docs.digitalsamba.com/reference/sdk/methods/endsession.md): endSession(true/false) - [featureEnabled()](https://docs.digitalsamba.com/reference/sdk/methods/featureenabled.md): featureEnabled(feature: string) - [hideCaptions()](https://docs.digitalsamba.com/reference/sdk/methods/hidecaptions.md) - [hideToolbar()](https://docs.digitalsamba.com/reference/sdk/methods/hidetoolbar.md) - [hideTopbar()](https://docs.digitalsamba.com/reference/sdk/methods/hidetopbar.md) - [leaveSession()](https://docs.digitalsamba.com/reference/sdk/methods/leavesession.md) - [listUsers()](https://docs.digitalsamba.com/reference/sdk/methods/listusers.md) - [load()](https://docs.digitalsamba.com/reference/sdk/methods/load.md): load(props?: InstanceProperties) - [lowerHand()](https://docs.digitalsamba.com/reference/sdk/methods/lowerhand.md): lowerHand(userId?: string) - [muteFrame()](https://docs.digitalsamba.com/reference/sdk/methods/muteframe.md) - [maximizeLocalTile()](https://docs.digitalsamba.com/reference/sdk/methods/maximizelocaltile.md) - [maximizeUser()](https://docs.digitalsamba.com/reference/sdk/methods/maximizeuser.md): maximizeUser(userId: string, tile = 'media' | 'screenshare') - [minimizeLocalTile()](https://docs.digitalsamba.com/reference/sdk/methods/minimizelocaltile.md) - [minimizeContent()](https://docs.digitalsamba.com/reference/sdk/methods/minimizecontent.md) - [minimizeUser()](https://docs.digitalsamba.com/reference/sdk/methods/minimizeuser.md) - [off()](https://docs.digitalsamba.com/reference/sdk/methods/off.md): off(event: string, callback: function) - [on()](https://docs.digitalsamba.com/reference/sdk/methods/on.md): on(event: string, callback: function) - [once()](https://docs.digitalsamba.com/reference/sdk/methods/once.md): once(event: string, callback: function) - [openLibraryFile()](https://docs.digitalsamba.com/reference/sdk/methods/openlibraryfile.md): openLibraryFile(id: string) - [openWhiteboard()](https://docs.digitalsamba.com/reference/sdk/methods/openwhiteboard.md): openWhiteboard(id?: string) - [pinUser()](https://docs.digitalsamba.com/reference/sdk/methods/pinuser.md): pinUser(userId: string, tile = 'media' | 'screenshare') - [raiseHand()](https://docs.digitalsamba.com/reference/sdk/methods/raisehand.md) - [removeFrameEventListener()](https://docs.digitalsamba.com/reference/sdk/methods/removeframeeventlistener.md): removeFrameEventListener(eventName, target, listener) - [removeTileAction()](https://docs.digitalsamba.com/reference/sdk/methods/removetileaction.md): removeTileAction(name: string) - [removeUICallback()](https://docs.digitalsamba.com/reference/sdk/methods/removeuicallback.md): removeUICallback(event: string, callback: function) - [removeUser()](https://docs.digitalsamba.com/reference/sdk/methods/removeuser.md): removeUser(userId: string) - [requestMute()](https://docs.digitalsamba.com/reference/sdk/methods/requestmute.md): requestMute(userId: string) - [requestToggleAudio()](https://docs.digitalsamba.com/reference/sdk/methods/requesttoggleaudio.md): (userId: string, shouldMute?: boolean) - [requestUnmute()](https://docs.digitalsamba.com/reference/sdk/methods/requestunmute.md): requestUnmute(userId: string) - [sendMessageToCustomTile()](https://docs.digitalsamba.com/reference/sdk/methods/sendmessagetocustomtile.md): sendMessageToCustomTile({name: string, event?: string, origin?: string, data?: any}) - [showCaptions()](https://docs.digitalsamba.com/reference/sdk/methods/showcaptions.md) - [showToolbar()](https://docs.digitalsamba.com/reference/sdk/methods/showtoolbar.md) - [showTopbar()](https://docs.digitalsamba.com/reference/sdk/methods/showtopbar.md) - [startRecording()](https://docs.digitalsamba.com/reference/sdk/methods/startrecording.md) - [startRestreaming()](https://docs.digitalsamba.com/reference/sdk/methods/startrestreaming.md) - [startScreenshare()](https://docs.digitalsamba.com/reference/sdk/methods/startscreenshare.md) - [stopRecording()](https://docs.digitalsamba.com/reference/sdk/methods/stoprecording.md) - [stopRestreaming()](https://docs.digitalsamba.com/reference/sdk/methods/stoprestreaming.md) - [stopScreenshare()](https://docs.digitalsamba.com/reference/sdk/methods/stopscreenshare.md) - [toggleAudio()](https://docs.digitalsamba.com/reference/sdk/methods/toggleaudio.md): toggleAudio(newState?: boolean) - [toggleCaptions()](https://docs.digitalsamba.com/reference/sdk/methods/togglecaptions.md): toggleCaptions(newState?: boolean) - [toggleMuteFrame()](https://docs.digitalsamba.com/reference/sdk/methods/togglemuteframe.md): toggleMuteFrame(newState?: boolean) - [toggleToolbar()](https://docs.digitalsamba.com/reference/sdk/methods/toggletoolbar.md): toggleToolbar(newState?: boolean) - [toggleTopbar()](https://docs.digitalsamba.com/reference/sdk/methods/toggletopbar.md): toggleTopbar(newState?: boolean) - [toggleVideo()](https://docs.digitalsamba.com/reference/sdk/methods/togglevideo.md): toggleVideo(newState?: boolean) - [toggleWhiteboard()](https://docs.digitalsamba.com/reference/sdk/methods/togglewhiteboard.md): toggleWhiteboard(show: boolean, id: string) - [toggleLibraryFile()](https://docs.digitalsamba.com/reference/sdk/methods/togglelibraryfile.md): toggleLibraryFile(id?: string, show?: boolean) - [unmuteFrame()](https://docs.digitalsamba.com/reference/sdk/methods/unmuteframe.md) - [unpinUser()](https://docs.digitalsamba.com/reference/sdk/methods/unpinuser.md) - [Events](https://docs.digitalsamba.com/reference/sdk/events.md) - [activeSpeakerChanged](https://docs.digitalsamba.com/reference/sdk/events/activespeakerchanged.md) - [appError](https://docs.digitalsamba.com/reference/sdk/events/apperror.md) - [appLanguageChanged](https://docs.digitalsamba.com/reference/sdk/events/applanguagechanged.md) - [audioDisabled](https://docs.digitalsamba.com/reference/sdk/events/audiodisabled.md) - [audioEnabled](https://docs.digitalsamba.com/reference/sdk/events/audioenabled.md) - [captionsDisabled](https://docs.digitalsamba.com/reference/sdk/events/captionsdisabled.md) - [captionsEnabled](https://docs.digitalsamba.com/reference/sdk/events/captionsenabled.md) - [captionsFontSizeChanged](https://docs.digitalsamba.com/reference/sdk/events/captionsfontsizechanged.md) - [captionsSpokenLanguageChanged](https://docs.digitalsamba.com/reference/sdk/events/captionsspokenlanguagechanged.md) - [chatMessageReceived](https://docs.digitalsamba.com/reference/sdk/events/chatmessagereceived.md) - [connectionFailure](https://docs.digitalsamba.com/reference/sdk/events/connectionfailure.md) - [featureSetUpdated](https://docs.digitalsamba.com/reference/sdk/events/featuresetupdated.md) - [frameLoaded](https://docs.digitalsamba.com/reference/sdk/events/frameloaded.md) - [handRaised](https://docs.digitalsamba.com/reference/sdk/events/handraised.md) - [handLowered](https://docs.digitalsamba.com/reference/sdk/events/handlowered.md) - [layoutModeChanged](https://docs.digitalsamba.com/reference/sdk/events/layoutmodechanged.md) - [mediaConnectionFailed](https://docs.digitalsamba.com/reference/sdk/events/mediaconnectionfailed.md) - [mediaDeviceChanged](https://docs.digitalsamba.com/reference/sdk/events/mediadevicechanged.md) - [permissionsChanged](https://docs.digitalsamba.com/reference/sdk/events/permissionschanged.md) - [recordingFailed](https://docs.digitalsamba.com/reference/sdk/events/recordingfailed.md) - [recordingStarted](https://docs.digitalsamba.com/reference/sdk/events/recordingstarted.md) - [recordingStopped](https://docs.digitalsamba.com/reference/sdk/events/recordingstopped.md) - [roleChanged](https://docs.digitalsamba.com/reference/sdk/events/rolechanged.md) - [roomStateUpdated](https://docs.digitalsamba.com/reference/sdk/events/roomstateupdated.md) - [screenshareStarted](https://docs.digitalsamba.com/reference/sdk/events/screensharestarted.md) - [screenshareStopped](https://docs.digitalsamba.com/reference/sdk/events/screensharestopped.md) - [sessionEnded](https://docs.digitalsamba.com/reference/sdk/events/sessionended.md) - [speakerStoppedTalking](https://docs.digitalsamba.com/reference/sdk/events/speakerstoppedtalking.md) - [userJoined](https://docs.digitalsamba.com/reference/sdk/events/userjoined.md) - [userLeft](https://docs.digitalsamba.com/reference/sdk/events/userleft.md) - [usersUpdated](https://docs.digitalsamba.com/reference/sdk/events/usersupdated.md) - [videoDisabled](https://docs.digitalsamba.com/reference/sdk/events/videodisabled.md) - [videoEnabled](https://docs.digitalsamba.com/reference/sdk/events/videoenabled.md) - [virtualBackgroundChanged](https://docs.digitalsamba.com/reference/sdk/events/virtualbackgroundchanged.md) - [virtualBackgroundDisabled](https://docs.digitalsamba.com/reference/sdk/events/virtualbackgrounddisabled.md) - [Properties](https://docs.digitalsamba.com/reference/sdk/properties.md) - [features](https://docs.digitalsamba.com/reference/sdk/properties/features.md) - [localUser](https://docs.digitalsamba.com/reference/sdk/properties/localuser.md) - [permissionManager](https://docs.digitalsamba.com/reference/sdk/properties/permissionmanager.md) - [roomState](https://docs.digitalsamba.com/reference/sdk/properties/roomstate.md) - [REST API](https://docs.digitalsamba.com/reference/rest-api.md) - [Rate limiting](https://docs.digitalsamba.com/reference/rest-api/rate-limiting.md) - [Pagination](https://docs.digitalsamba.com/reference/rest-api/pagination.md) - [Default room settings](https://docs.digitalsamba.com/reference/rest-api/default-room-settings.md) - [List](https://docs.digitalsamba.com/reference/rest-api/default-room-settings/list.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/default-room-settings/edit.md) - [Rooms](https://docs.digitalsamba.com/reference/rest-api/rooms.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/rooms/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/rooms/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/rooms/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/rooms/delete.md) - [All resources](https://docs.digitalsamba.com/reference/rest-api/rooms/delete/all-resources.md) - [Concrete resource](https://docs.digitalsamba.com/reference/rest-api/rooms/delete/concrete-resource.md) - [Files](https://docs.digitalsamba.com/reference/rest-api/rooms/files.md) - [Chat](https://docs.digitalsamba.com/reference/rest-api/rooms/chat.md) - [List](https://docs.digitalsamba.com/reference/rest-api/rooms/chat/list.md) - [Export](https://docs.digitalsamba.com/reference/rest-api/rooms/chat/export.md) - [Questions & Answers](https://docs.digitalsamba.com/reference/rest-api/rooms/questions-and-answers.md) - [Ask question](https://docs.digitalsamba.com/reference/rest-api/rooms/questions-and-answers/ask-question.md) - [List](https://docs.digitalsamba.com/reference/rest-api/rooms/questions-and-answers/list.md) - [Export](https://docs.digitalsamba.com/reference/rest-api/rooms/questions-and-answers/export.md) - [Transcription](https://docs.digitalsamba.com/reference/rest-api/rooms/transcription.md) - [List](https://docs.digitalsamba.com/reference/rest-api/rooms/transcription/list.md) - [Export](https://docs.digitalsamba.com/reference/rest-api/rooms/transcription/export.md) - [Start](https://docs.digitalsamba.com/reference/rest-api/rooms/transcription/start.md) - [Stop](https://docs.digitalsamba.com/reference/rest-api/rooms/transcription/stop.md) - [Sessions](https://docs.digitalsamba.com/reference/rest-api/sessions.md) - [List](https://docs.digitalsamba.com/reference/rest-api/sessions/list.md) - [End](https://docs.digitalsamba.com/reference/rest-api/sessions/end.md) - [Delete resources](https://docs.digitalsamba.com/reference/rest-api/sessions/delete-resources.md) - [All resources](https://docs.digitalsamba.com/reference/rest-api/sessions/delete-resources/all-resources.md) - [Concrete resource](https://docs.digitalsamba.com/reference/rest-api/sessions/delete-resources/concrete-resource.md) - [Transcripts](https://docs.digitalsamba.com/reference/rest-api/sessions/transcripts.md) - [Summary (AI)](https://docs.digitalsamba.com/reference/rest-api/sessions/summary-ai.md) - [Participants](https://docs.digitalsamba.com/reference/rest-api/participants.md) - [List](https://docs.digitalsamba.com/reference/rest-api/participants/list.md) - [Raise hand](https://docs.digitalsamba.com/reference/rest-api/participants/raise-hand.md) - [Lower hand](https://docs.digitalsamba.com/reference/rest-api/participants/lower-hand.md) - [Roles and permissions](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions.md) - [Permissions](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions/permissions.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/roles-and-permissions/delete.md) - [Live usage](https://docs.digitalsamba.com/reference/rest-api/live-usage.md) - [Rooms](https://docs.digitalsamba.com/reference/rest-api/live-usage/rooms.md) - [Participants](https://docs.digitalsamba.com/reference/rest-api/live-usage/participants.md) - [Statistics](https://docs.digitalsamba.com/reference/rest-api/statistics.md) - [Current period](https://docs.digitalsamba.com/reference/rest-api/statistics/current-period.md) - [Team](https://docs.digitalsamba.com/reference/rest-api/statistics/team.md) - [Room](https://docs.digitalsamba.com/reference/rest-api/statistics/room.md) - [Started sessions](https://docs.digitalsamba.com/reference/rest-api/statistics/started-sessions.md) - [Tokens](https://docs.digitalsamba.com/reference/rest-api/tokens.md) - [Properties](https://docs.digitalsamba.com/reference/rest-api/tokens/properties.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/tokens/create.md) - [Recordings](https://docs.digitalsamba.com/reference/rest-api/recordings.md) - [List](https://docs.digitalsamba.com/reference/rest-api/recordings/list.md) - [Download](https://docs.digitalsamba.com/reference/rest-api/recordings/download.md) - [Start](https://docs.digitalsamba.com/reference/rest-api/recordings/start.md) - [Stop](https://docs.digitalsamba.com/reference/rest-api/recordings/stop.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/recordings/delete.md) - [Archive](https://docs.digitalsamba.com/reference/rest-api/recordings/archive.md) - [Unarchive](https://docs.digitalsamba.com/reference/rest-api/recordings/unarchive.md) - [Restreamers](https://docs.digitalsamba.com/reference/rest-api/restreamers.md) - [Start](https://docs.digitalsamba.com/reference/rest-api/restreamers/start.md) - [Stop](https://docs.digitalsamba.com/reference/rest-api/restreamers/stop.md) - [Polls](https://docs.digitalsamba.com/reference/rest-api/polls.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/polls/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/polls/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/polls/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/polls/delete.md) - [Export](https://docs.digitalsamba.com/reference/rest-api/polls/export.md) - [Results](https://docs.digitalsamba.com/reference/rest-api/polls/results.md) - [Quizzes](https://docs.digitalsamba.com/reference/rest-api/quizzes.md) - [Content Library](https://docs.digitalsamba.com/reference/rest-api/content-library.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/content-library/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/content-library/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/content-library/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/content-library/delete.md) - [Folders](https://docs.digitalsamba.com/reference/rest-api/content-library/folders.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/content-library/folders/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/content-library/folders/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/content-library/folders/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/content-library/folders/delete.md) - [Files](https://docs.digitalsamba.com/reference/rest-api/content-library/files.md) - [Upload](https://docs.digitalsamba.com/reference/rest-api/content-library/files/upload.md) - [Webapps](https://docs.digitalsamba.com/reference/rest-api/content-library/files/webapps.md) - [Whiteboards](https://docs.digitalsamba.com/reference/rest-api/content-library/files/whiteboards.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/content-library/files/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/content-library/files/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/content-library/files/delete.md) - [Telephony](https://docs.digitalsamba.com/reference/rest-api/telephony.md) - [Connect to bridge](https://docs.digitalsamba.com/reference/rest-api/telephony/connect-to-bridge.md) - [Disconnect from bridge](https://docs.digitalsamba.com/reference/rest-api/telephony/disconnect-from-bridge.md) - [Participant Join](https://docs.digitalsamba.com/reference/rest-api/telephony/participant-join.md) - [Participant Leave](https://docs.digitalsamba.com/reference/rest-api/telephony/participant-leave.md) - [Raise hand](https://docs.digitalsamba.com/reference/rest-api/telephony/raise-hand.md) - [Lower hand](https://docs.digitalsamba.com/reference/rest-api/telephony/lower-hand.md) - [Webhooks](https://docs.digitalsamba.com/reference/rest-api/webhooks.md) - [Payload structure](https://docs.digitalsamba.com/reference/rest-api/webhooks/payload-structure.md) - [Create](https://docs.digitalsamba.com/reference/rest-api/webhooks/create.md) - [Edit](https://docs.digitalsamba.com/reference/rest-api/webhooks/edit.md) - [List](https://docs.digitalsamba.com/reference/rest-api/webhooks/list.md) - [Delete](https://docs.digitalsamba.com/reference/rest-api/webhooks/delete.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.digitalsamba.com/reference/introduction.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.