Meeting
Properties
Property name | Data type | Use |
---|---|---|
connectionConfig | DyteConnectionConfig | Connection info about the current meeting in progress, as defined below |
uiConfig | DyteUIConfig | The UI and layout of the current meeting (see customize the meeting UI for available options) |
controlBar | DyteControlBar | Control bar at the bottom of the default UI (see control bar options for more details) |
grid | DyteGrid | Participant video grid (see grid layout for more details) |
participants | Array <DyteSelfParticipant | DyteParticipant> | Array of participants, including the current participant (see participant controls and actions for more info) |
self | DyteSelfParticipant | The current participant (see self participant controls for more info) |
plugins | Array <DytePlugin> | Array of plugins enabled for the current meeting |
Events | Enum (typeof Events) | Enum of events emitted by the meeting component (see events for more details) |
showSetupScreen | boolean | Should the participants be shown the audio / video setup screen |
Methods
Method name | Params (with data type) | Use |
---|---|---|
init | parentElementID: string | Initialize the meeting UI under the parent with given element ID |
sendRoomMessage | message: any | Send a custom event to the room (see this section for usage) |
sendMessage | peerId: string, message: any | Send a message to specified peer (see this section for usage) |
on | event: DyteMeetingEvent, handler: function | Capture the event specified by the event and execute handler as the callback function with params supported by the event (see events for more details) |
onError | handler: function | Capture 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) |
leaveRoom | Makes the current participant leave the meeting | |
updateUIConfig | uiConfig: DyteUIConfig | Change 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) |