RTKParticipants
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.
- RTKParticipants
- .waitlisted
- .joined
.active- .videoSubscribed
- .audioSubscribed
- .pinned
- .all
- .pip
- .socketJoined
- .mediaJoined
- .viewMode
- .currentPage
- .lastActiveSpeaker
- .selectedPeers
- .count
- .maxActiveParticipantsCount
- .pageCount
- .setMaxActiveParticipantsCount(limit:)
- .acceptWaitingRoomRequest(id)
- .acceptAllWaitingRoomRequest()
- .rejectWaitingRoomRequest(id)
- .setViewMode(viewMode)
- .setPage(page)
- .disableAllAudio(allowUnmute)
- .disableAllVideo()
.disableAudio(participantId).disableVideo(participantId).kick(participantId)- .kickAll()
- .broadcastMessage(target)
- .getAllJoinedPeers()
- .getParticipantsInMeetingPreJoin()
meeting.participants.waitlisted
Returns a list of participants waiting to join the meeting.
Kind: instance property of RTKParticipants
meeting.participants.joined
Returns a list of all participants in the meeting.
Kind: instance property of RTKParticipants
meeting.participants.active
Deprecated
Kind: instance property of RTKParticipants
meeting.participants.videoSubscribed
Returns a list of participants whose video streams are currently consumed.
Kind: instance property of RTKParticipants
meeting.participants.audioSubscribed
Returns a list of participants whose audio streams are currently consumed.
Kind: instance property of RTKParticipants
meeting.participants.pinned
Returns a list of participants who have been pinned.
Kind: instance property of RTKParticipants
meeting.participants.all
Returns all added participants irrespective of whether they are currently in the meeting or not
Kind: instance property of RTKParticipants
meeting.participants.pip
Return the controls for Picture-in-Picture
Kind: instance property of RTKParticipants
meeting.participants.socketJoined
Returns true if the local participant has joined the meeting.
Kind: instance property of RTKParticipants
meeting.participants.mediaJoined
Returns true if the local participant has joined the meeting.
Kind: instance property of RTKParticipants
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 RTKParticipants
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 RTKParticipants
meeting.participants.lastActiveSpeaker
This stores the participantId of the last participant who spoke in the meeting.
Kind: instance property of RTKParticipants
meeting.participants.selectedPeers
Keeps a list of all participants who have been present in the selected peers list.
Kind: instance property of RTKParticipants
meeting.participants.count
Returns the number of participants who are joined in the meeting.
Kind: instance property of RTKParticipants
meeting.participants.maxActiveParticipantsCount
Returns the maximum number of participants that can be present in the active map.
Kind: instance property of RTKParticipants
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 RTKParticipants
meeting.participants.setMaxActiveParticipantsCount(limit:)
Updates the maximum number of participants that are populated in the active map.
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| limit: | Updated max limit |
meeting.participants.acceptWaitingRoomRequest(id)
Accepts requests from waitlisted participants if user has appropriate permissions.
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| id | peerId or userId of the waitlisted participant. |
meeting.participants.acceptAllWaitingRoomRequest()
We need a new event for socket service events since if we send them all together, sequence of events can be unreliable
Kind: instance method of RTKParticipants
meeting.participants.rejectWaitingRoomRequest(id)
Rejects requests from waitlisted participants if user has appropriate permissions.
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| id | participantId 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 RTKParticipants
| Param | Description |
|---|---|
| viewMode | The 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 RTKParticipants
| Param | Description |
|---|---|
| page | The page number to be set. |
meeting.participants.disableAllAudio(allowUnmute)
Disables audio for all participants in the meeting.
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| allowUnmute | Allow participants to unmute after they are muted. |
meeting.participants.disableAllVideo()
Disables video for all participants in the meeting.
Kind: instance method of RTKParticipants
meeting.participants.disableAudio(participantId)
Deprecated
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| participantId | ID of participant to be muted. |
meeting.participants.disableVideo(participantId)
Deprecated
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| participantId | ID of participant to be muted. |
meeting.participants.kick(participantId)
Deprecated
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| participantId | ID of participant to be kicked. |
meeting.participants.kickAll()
Kicks all participants from the meeting.
Kind: instance method of RTKParticipants
meeting.participants.broadcastMessage(target)
Broadcasts the message to participants
If no target is specified it is sent to all participants including self.
Kind: instance method of RTKParticipants
| Param | Description |
|---|---|
| target | object containing a list of participantIds or object containing presetName - every user with that preset will be sent the message |
meeting.participants.getAllJoinedPeers()
Returns all peers currently present in the room
If you are in a group call, use meeting.participants.joined
instead
Kind: instance method of RTKParticipants
meeting.participants.getParticipantsInMeetingPreJoin()
Returns all peers currently in the room, is a non paginated call
and should only be used if you are in a non room joined state,
if in a joined group call, use meeting.participants.joined
Kind: instance method of RTKParticipants