このモジュールは、ミーティング内の参加者全員（ローカルユーザーを除く）を表します。 次の 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 のインスタンスプロパティ
ピクチャーインピクチャー（PiP）のコントロールを返します。
種別: RTKParticipants のインスタンスプロパティ
ミーティングが ACTIVE_GRID モードか PAGINATED モードかを示します。
ACTIVE_GRID モードでは、participants.active マップに参加者が動的に入ります。ほかの参加者が音声のミュートを解除したり、ビデオをオンにしたりすると、マップ内の参加者は変わり続けます。
PAGINATED モードでは、participants.active マップへの参加者の投入は一度だけです。マップ内の参加者が変わるのは、ユーザーが setPage(page) でページ番号を変更したときだけです。
種別: RTKParticipants のインスタンスプロパティ
PAGINATED モードでユーザーが設定した現在のページを示します。
ミーティングが ACTIVE_GRID モードの場合、この値は 0 です。
種別: RTKParticipants のインスタンスプロパティ
ミーティングで最後に発言した参加者の participantId を保持します。
種別: RTKParticipants のインスタンスプロパティ
選択済みピアの一覧に入ったことがある、すべての参加者を保持します。
種別: 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 を含むオブジェクト。その Preset を持つ全ユーザーにメッセージを送ります |
ルームに現在いる全ピアを返します。
グループ通話中は、代わりに meeting.participants.joined を使ってください。
種別: RTKParticipants のインスタンスメソッド
| パラメーター | 型 |
|---|---|
| searchQuery | string |
| limit | number |
| offset | number |
ルームに現在いる全ピアを返します。ページ分割のない呼び出しです。
ルームに未参加の状態でのみ使ってください。参加済みのグループ通話では、meeting.participants.joined を使います。
種別: RTKParticipants のインスタンスメソッド