该模块表示会议中的所有参与者（本地用户除外）。 它包含 4 个映射表：
joined: 所有已加入会议的参与者的映射表。waitlisted: 所有已被添加到候补名单中的参与者的映射表。active: 应在会议网格中显示的活动参与者的映射表。pinned: 已固定参与者的映射表。
- RTKParticipants
- .waitlisted
- .joined
- .active
- .videoSubscribed
- .audioSubscribed
- .pinned
- .all
- .pip
- .viewMode
- .currentPage
- .lastActiveSpeaker
- .selectedPeers
- .count
- .maxActiveParticipantsCount
- .pageCount
- .setMaxActiveParticipantsCount(limit)
- .acceptWaitingRoomRequest(id)
- .acceptAllWaitingRoomRequest(userIds)
- .rejectWaitingRoomRequest(id)
- .setViewMode(viewMode)
- .subscribe(peerIds, [kinds])
- .unsubscribe(peerIds, [kinds])
- .setPage(page)
- .disableAllAudio(allowUnmute)
- .disableAllVideo()
- .kickAll()
- .broadcastMessage(type, payload, target)
- .getAllJoinedPeers(searchQuery, limit, offset)
- .getParticipantsInMeetingPreJoin()
返回等待加入会议的参与者列表。
类型: RTKParticipants 的实例属性
返回会议中所有参与者的列表。
类型: RTKParticipants 的实例属性
返回当前其流被消费的参与者列表。
类型: RTKParticipants 的实例属性
返回当前其视频流被消费的参与者列表。
类型: RTKParticipants 的实例属性
返回当前其音频流被消费的参与者列表。
类型: RTKParticipants 的实例属性
返回已被固定的参与者列表。
类型: RTKParticipants 的实例属性
返回所有已添加的参与者，无论他们当前是否在会议中
类型: RTKParticipants 的实例属性
返回画中画的控制项
类型: RTKParticipants 的实例属性
指示会议是处于 'ACTIVE_GRID' 模式还是 'PAGINATED' mode。
在 'ACTIVE_GRID' 模式下，参与者会被动态填充到 participants.active 映射表中。当其他参与者取消静音其音频或开启视频时，该映射表中存在的参与者将不断发生变化。
在 'PAGINATED' 模式下，参与者仅会被填充到 participants.active 映射表中一次，并且只有当用户使用 setPage(page) 更改页码时，该映射表中的参与者才会发生变化。
类型: RTKParticipants 的实例属性
这指示了用户在 PAGINATED 模式下设置的当前页面。 如果会议处于 ACTIVE_GRID 模式，则该值将为 0。
类型: RTKParticipants 的实例属性
这存储了在会议中最后发言的参与者的 participantId。
类型: RTKParticipants 的实例属性
保留已存在于所选 Peer 列表中的所有参与者的列表。
类型: RTKParticipants 的实例属性
返回已加入会议的参与者人数。
类型: RTKParticipants 的实例属性
返回 active 映射表中可以存在的最大参与者数。
类型: RTKParticipants 的实例属性
返回 PAGINATED 模式下会议中可用的页面数量。 如果会议处于 ACTIVE_GRID 模式，则该值将为 0。
类型: RTKParticipants 的实例属性
更新 active 映射表中填充的最大参与者数。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| limit | number |
更新后的最大限制 |
如果用户拥有相应权限，则接受来自候补名单参与者的请求。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| id | string |
候补名单参与者的 peerId 或 userId。 |
我们需要为套接字服务事件定义一个新事件，因为如果将它们一起发送，事件的顺序可能会变得不可靠
类型: RTKParticipants 的实例方法
| 参数 | 类型 |
|---|---|
| userIds | Array.<string> |
如果用户拥有相应权限，则拒绝来自候补名单参与者的请求。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| id | string |
候补名单参与者的 participantId。 |
将会议的视图模式设置为 ACTIVE_GRID 或 PAGINATED。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| viewMode | ViewMode |
填充 active 映射表的模式 |
类型: RTKParticipants 的实例方法
| 参数 | 类型 |
|---|---|
| peerIds | Array.<string> |
| [kinds] | Array.<('audio'|'video'|'screenshareAudio'|'screenshareVideo')> |
类型: RTKParticipants 的实例方法
| 参数 | 类型 |
|---|---|
| peerIds | Array.<string> |
| [kinds] | Array.<('audio'|'video'|'screenshareAudio'|'screenshareVideo')> |
在 PAGINATED 模式下，使用参数 page 指示的页码中存在的参与者填充 active 映射表。
在 ACTIVE_GRID 模式下不执行任何操作。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| page | number |
要设置的页码。 |
禁用会议中所有参与者的音频。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| allowUnmute | boolean |
允许参与者在被静音后取消静音。 |
禁用会议中所有参与者的视频。
类型: RTKParticipants 的实例方法
将所有参与者移出会议。
类型: RTKParticipants 的实例方法
向参与者广播消息
如果未指定 target，它将发送给包括 self 在内的所有参与者。
类型: RTKParticipants 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| type | string |
|
| payload | BroadcastMessagePayload |
|
| target | BroadcastMessageTarget |
包含 participantIds 列表的对象，或包含 presetName 的对象 - 拥有该预设的每个用户都将被发送该消息 |
返回当前存在于会议室中的所有 Peer
如果您处于群组通话中，请改用 meeting.participants.joined
类型: RTKParticipants 的实例方法
| 参数 | 类型 |
|---|---|
| searchQuery | string |
| limit | number |
| offset | number |
返回当前在会议室中的所有 Peer，这是一个非分页调用，并且仅在您处于未加入会议室状态时使用。如果处于已加入的群组通话中，请使用 meeting.participants.joined
类型: RTKParticipants 的实例方法