Skip to main content

DyteParticipants

This module represents all the participants in the meeting (except the local user). It consists of 4 maps:

  • joined: A map of all participants that have joined the meeting.
  • waitlisted: A map of all participants that have been added to the waitlist.
  • active: A map of active participants who should be displayed in the meeting grid.
  • pinned: A map of pinned participants.

meeting.participants.waitlisted

Returns a list of participants waiting to join the meeting.

Kind: instance property of DyteParticipants

meeting.participants.joined

Returns a list of all participants in the meeting.

Kind: instance property of DyteParticipants

meeting.participants.active

Returns a list of participants whose streams are currently consumed.

Kind: instance property of DyteParticipants

meeting.participants.pinned

Returns a list of participants who have been pinned.

Kind: instance property of DyteParticipants

meeting.participants.viewMode

Indicates whether the meeting is in 'ACTIVE_GRID' mode or 'PAGINATED' mode.

In 'ACTIVE_GRID' mode, participants are populated in the participants.active map dynamically. The participants present in the map will keep changing when other participants unmute their audio or turn on their videos.

In 'PAGINATED' mode, participants are populated in the participants.active map just once, and the participants in the map will only change if the page number is changed by the user using setPage(page).

Kind: instance property of DyteParticipants

meeting.participants.currentPage

This indicates the current page that has been set by the user in PAGINATED mode. If the meeting is in ACTIVE_GRID mode, this value will be 0.

Kind: instance property of DyteParticipants

meeting.participants.lastActiveSpeaker

This stores the participantId of the last participant who spoke in the meeting.

Kind: instance property of DyteParticipants

meeting.participants.count

Returns the number of participants who are joined in the meeting.

Kind: instance property of DyteParticipants

meeting.participants.maxActiveParticipantsCount

Returns the maximum number of participants that can be present in the active map.

Kind: instance property of DyteParticipants

meeting.participants.pageCount

Returns the number of pages that are available in the meeting in PAGINATED mode. If the meeting is in ACTIVE_GRID mode, this value will be 0.

Kind: instance property of DyteParticipants

meeting.participants.acceptWaitingRoomRequest(id)

Accepts requests from waitlisted participants if user has appropriate permissions.

Kind: instance method of DyteParticipants

ParamDescription
idparticipantId of the waitlisted participant.

meeting.participants.rejectWaitingRoomRequest(id)

Rejects requests from waitlisted participants if user has appropriate permissions.

Kind: instance method of DyteParticipants

ParamDescription
idparticipantId of the waitlisted participant.

meeting.participants.setViewMode(viewMode)

Sets the view mode of the meeting to either ACTIVE_GRID or PAGINATED.

Kind: instance method of DyteParticipants

ParamDescription
viewModeThe mode in which the active map should be populated

meeting.participants.setPage(page)

Populates the active map with participants present in the page number indicated by the parameter page in PAGINATED mode. Does not do anything in ACTIVE_GRID mode.

Kind: instance method of DyteParticipants

ParamDescription
pageThe page number to be set.

meeting.participants.disableAllAudio(allowUnMute)

Disables audio for all participants in the meeting.

Kind: instance method of DyteParticipants

ParamDescription
allowUnMuteAllow participants to unmute after they are muted.

meeting.participants.disableAllVideo()

Disables video for all participants in the meeting.

Kind: instance method of DyteParticipants

meeting.participants.disableAudio(participantId)

Deprecated

Kind: instance method of DyteParticipants

ParamDescription
participantIdID of participant to be muted.

meeting.participants.disableVideo(participantId)

Deprecated

Kind: instance method of DyteParticipants

ParamDescription
participantIdID of participant to be muted.

meeting.participants.kick(participantId)

Deprecated

Kind: instance method of DyteParticipants

ParamDescription
participantIdID of participant to be kicked.

meeting.participants.kickAll()

Kicks all participants from the meeting.

Kind: instance method of DyteParticipants

meeting.participants.broadcastMessage()

Broadcasts the message to all participants including self.

Kind: instance method of DyteParticipants

meeting.participants.acceptAllRequestToJoinStageRequests()

Accepts all join stage requests

Kind: instance method of DyteParticipants