RemoteParticipant interface

包:

@azure/communication-calling

表示呼叫中的远程参与者。

扩展

ParticipantInfo

属性

callEndReason	参与者离开呼叫的原因，包含代码/subCode/消息。
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 事件的函数。
on("isMutedChanged", PropertyChangedEvent)	isMutedChanged 事件的 Subscribe 函数。
on("isSpeakingChanged", PropertyChangedEvent)	isSpeakingChanged 事件的 Subscribe 函数。
on("roleChanged", PropertyChangedEvent)	为 roleChanged 事件订阅函数。
on("stateChanged", PropertyChangedEvent)	stateChanged 事件的订阅函数。
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	订阅 videoStreamsUpdated 事件的函数。

属性详细信息

callEndReason

参与者离开呼叫的原因，包含代码/subCode/消息。

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

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 事件的订阅函数。

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，将在此集合更改时调用，它将传递已添加和删除元素的数组。