Skip to main content

Meeting

Properties

Property nameData typeUse
connectionConfigDyteConnectionConfigConnection info about the current meeting in progress, as defined below
uiConfigDyteUIConfigThe UI and layout of the current meeting (see customize the meeting UI for available options)
controlBarDyteControlBarControl bar at the bottom of the default UI (see control bar options for more details)
gridDyteGridParticipant video grid (see grid layout for more details)
participantsArray <DyteSelfParticipant | DyteParticipant>Array of participants, including the current participant (see participant controls and actions for more info)
selfDyteSelfParticipantThe current participant (see self participant controls for more info)
pluginsArray <DytePlugin>Array of plugins enabled for the current meeting
EventsEnum (typeof Events)Enum of events emitted by the meeting component (see events for more details)
showSetupScreenbooleanShould the participants be shown the audio / video setup screen

Methods

Method nameParams (with data type)Use
initparentElementID: stringInitialize the meeting UI under the parent with given element ID
sendRoomMessagemessage: anySend a custom event to the room (see this section for usage)
sendMessagepeerId: string, message: anySend a message to specified peer (see this section for usage)
onevent: DyteMeetingEvent, handler: functionCapture the event specified by the event and execute handler as the callback function with params supported by the event (see events for more details)
onErrorhandler: functionCapture errors, if any, in the meeting creation and connection process and execute handler as the callback function for error handling (see error handling for more details)
leaveRoomMakes the current participant leave the meeting
updateUIConfiguiConfig: DyteUIConfigChange the UI and layout of the current meeting according to the relevant params specified in the object (see customize the meeting UI for available options)