DyteMeeting object

Methods

Method name

Params(dataType)

Use

sendRoomMessage

message: any

Send a custom event to the room

sendMessage

peerId: string, message: any

Send a message to specified peer

on

event: DyteMeetingEvent, data: function

Capture the event specified by the event and execute data as the callback function with params supported by the event (see Event listeners 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 UI layout for available options)

Public 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 UI layout for available options)

controlBar

DyteControlBar

Control bar at the bottom of the default UI (see control bar button 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 for more info)

self

DyteSelfParticipant

The current participant (see Participant controls for more info)

plugins

DytePlugin[]

Array of plugins enabled for the current meeting

Events

Enum (typeof Events)

Enum of events emitted by the meeting component (see Event listeners for more details)

showSetupScreen

boolean

Whether the participants should be shown the setup screen or not