共用方式為

RemoteParticipant interface

  • 參考
套件:
@azure/communication-calling

代表通話中的遠程參與者。

Extends
ParticipantInfo

屬性

callEndReason

參與者離開呼叫的原因，包含程序代碼/subCode/message。
isMuted

此遠端參與者是否設為靜音。
isSpeaking

此遠端參與者是否正在說話。
role

取得此遠端參與者的角色。
state

取得此遠端參與者的狀態。
videoStreams

此參與者擁有的影片串流集合。

繼承的屬性

displayName

如果已由該遠端參與者的端點設定，則為選擇性的顯示名稱。
endpointDetails

取得此遠端參與者的所有端點詳細數據
identifier

取得此遠端參與者的識別碼。

方法

mute()

將此遠端參與者的麥克風靜音。
off("displayNameChanged", PropertyChangedEvent)

displayNameChanged 事件的取消訂閱函式。
off("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的取消訂閱函式。
off("isSpeakingChanged", PropertyChangedEvent)

isSpeakingChanged 事件的取消訂閱函式。
off("roleChanged", PropertyChangedEvent)

roleChanged 事件的取消訂閱函式。
off("stateChanged", PropertyChangedEvent)

stateChanged 事件的取消訂閱函式。
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

取消訂閱videoStreamsUpdated事件的函式。
on("displayNameChanged", PropertyChangedEvent)

displayNameChanged 事件的 Subscribe 函式。
on("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。
on("isSpeakingChanged", PropertyChangedEvent)

isSpeakingChanged 事件的 Subscribe 函式。
on("roleChanged", PropertyChangedEvent)

roleChanged 事件的訂閱函式。
on("stateChanged", PropertyChangedEvent)

stateChanged 事件的 Subscribe 函式。
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

videoStreamsUpdated 事件的訂閱函式。

屬性詳細資料

callEndReason

參與者離開呼叫的原因，包含程序代碼/subCode/message。

callEndReason?: CallEndReason

屬性值

CallEndReason

isMuted

此遠端參與者是否設為靜音。

isMuted: boolean

屬性值

boolean

isSpeaking

此遠端參與者是否正在說話。

isSpeaking: boolean

屬性值

boolean

role

取得此遠端參與者的角色。

role: ParticipantRole

屬性值

ParticipantRole

state

取得此遠端參與者的狀態。

state: RemoteParticipantState

屬性值

RemoteParticipantState

videoStreams

此參與者擁有的影片串流集合。

videoStreams: readonly RemoteVideoStream[]

屬性值

readonly RemoteVideoStream[]

繼承的屬性詳細資料

displayName

如果已由該遠端參與者的端點設定，則為選擇性的顯示名稱。

displayName?: string

屬性值

string

繼承自ParticipantInfo.displayName

endpointDetails

取得此遠端參與者的所有端點詳細數據

endpointDetails: EndpointDetails[]

屬性值

EndpointDetails[]

繼承自ParticipantInfo.endpointDetails

identifier

取得此遠端參與者的識別碼。

identifier: CommunicationIdentifierKind

屬性值

CommunicationIdentifierKind

繼承自ParticipantInfo.identifier

方法詳細資料

mute()

將此遠端參與者的麥克風靜音。

function mute(): Promise<void>

傳回

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

displayNameChanged 事件的取消訂閱函式。

function off(event: "displayNameChanged", listener: PropertyChangedEvent)

參數

event

"displayNameChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

off("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的取消訂閱函式。

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

參數

event

"isMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

off("isSpeakingChanged", PropertyChangedEvent)

isSpeakingChanged 事件的取消訂閱函式。

function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)

參數

event

"isSpeakingChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

off("roleChanged", PropertyChangedEvent)

roleChanged 事件的取消訂閱函式。

function off(event: "roleChanged", listener: PropertyChangedEvent)

參數

event

"roleChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

off("stateChanged", PropertyChangedEvent)

stateChanged 事件的取消訂閱函式。

function off(event: "stateChanged", listener: PropertyChangedEvent)

參數

event

"stateChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，用來訂閱此事件。

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

取消訂閱videoStreamsUpdated事件的函式。

function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)

參數

event

"videoStreamsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<RemoteVideoStream>

回呼 fn，用來訂閱此事件。

on("displayNameChanged", PropertyChangedEvent)

displayNameChanged 事件的 Subscribe 函式。

function on(event: "displayNameChanged", listener: PropertyChangedEvent)

參數

event

"displayNameChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

on("isMutedChanged", PropertyChangedEvent)

isMutedChanged 事件的 Subscribe 函式。

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

參數

event

"isMutedChanged"

事件名稱。

listener
PropertyChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

on("isSpeakingChanged", PropertyChangedEvent)

isSpeakingChanged 事件的 Subscribe 函式。

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 事件的 Subscribe 函式。

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

CollectionUpdatedEvent<RemoteVideoStream>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。