RemoteParticipant interface
通話のリモート参加者を表します。
- Extends
プロパティ
| call |
参加者が呼び出しを終了した理由。コード/サブコード/メッセージが含まれています。 |
| is |
このリモート参加者がミュートされているかどうか。 |
| is |
このリモート参加者が話しているかどうか。 |
| role | このリモート参加者の役割を取得します。 |
| state | このリモート参加者の状態を取得します。 |
| video |
この参加者が持っているビデオ ストリームのコレクション。 |
継承されたプロパティ
| display |
リモート参加者のエンドポイントによって設定された場合は、オプションの表示名。 |
| endpoint |
このリモート参加者のすべてのエンドポイントの詳細を取得する |
| identifier | このリモート参加者の識別子を取得します。 |
メソッド
プロパティの詳細
callEndReason
isMuted
このリモート参加者がミュートされているかどうか。
isMuted: booleanプロパティ値
boolean
isSpeaking
このリモート参加者が話しているかどうか。
isSpeaking: booleanプロパティ値
boolean
role
state
videoStreams
この参加者が持っているビデオ ストリームのコレクション。
videoStreams: readonly RemoteVideoStream[]プロパティ値
readonly RemoteVideoStream[]
継承されたプロパティの詳細
displayName
リモート参加者のエンドポイントによって設定された場合は、オプションの表示名。
displayName?: stringプロパティ値
string
endpointDetails
このリモート参加者のすべてのエンドポイントの詳細を取得する
endpointDetails: EndpointDetails[]プロパティ値
identifier
このリモート参加者の識別子を取得します。
identifier: CommunicationIdentifierKindプロパティ値
Inherited FromParticipantInfo.identifier
メソッドの詳細
mute()
このリモート参加者のマイクをミュートします。
function mute(): Promise<void>戻り値
Promise<void>
off("displayNameChanged", PropertyChangedEvent)
displayNameChanged イベントの Unsubscribe 関数。
function off(event: "displayNameChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"displayNameChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("isMutedChanged", PropertyChangedEvent)
isMutedChanged イベントの Unsubscribe 関数。
function off(event: "isMutedChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"isMutedChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("isSpeakingChanged", PropertyChangedEvent)
isSpeakingChanged イベントの Unsubscribe 関数。
function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"isSpeakingChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("roleChanged", PropertyChangedEvent)
roleChanged イベントの Unsubscribe 関数。
function off(event: "roleChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"roleChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("stateChanged", PropertyChangedEvent)
stateChanged イベントの Unsubscribe 関数。
function off(event: "stateChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"stateChanged"
イベント名。
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn。
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
videoStreamsUpdated イベントの Unsubscribe 関数。
function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)パラメーター
- event
-
"videoStreamsUpdated"
イベント名。
- listener
このイベントのサブスクライブに使用されたコールバック fn。
on("displayNameChanged", PropertyChangedEvent)
displayNameChanged イベントのサブスクライブ関数。
function on(event: "displayNameChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"displayNameChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("isMutedChanged", PropertyChangedEvent)
isMutedChanged イベントのサブスクライブ関数。
function on(event: "isMutedChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"isMutedChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("isSpeakingChanged", PropertyChangedEvent)
isSpeakingChanged イベントのサブスクライブ関数。
function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"isSpeakingChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("roleChanged", PropertyChangedEvent)
roleChanged イベントのサブスクライブ関数。
function on(event: "roleChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"roleChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("stateChanged", PropertyChangedEvent)
stateChanged イベントのサブスクライブ関数。
function on(event: "stateChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"stateChanged"
イベント名。
- listener
- PropertyChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
videoStreamsUpdated イベントのサブスクライブ関数。
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)パラメーター
- event
-
"videoStreamsUpdated"
イベント名。
- listener
このコレクションが変更されたときに呼び出されるコールバック fn は、追加および削除された要素の配列を渡します。