通过

SpotlightCallFeature interface

  • 参考
包:
@azure/communication-calling

聚焦呼叫功能。

扩展
CallFeature

属性

maxParticipantsToSpotlight

返回可聚焦的最大参与者数

继承属性

name

功能名称。

方法

getSpotlightedParticipants()
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

SpotlightUpdated 事件的订阅函数
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

SpotlightUpdated 事件的订阅函数
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

停止为所有参与者聚焦。
stopSpotlight(CommunicationIdentifier[])

继承的方法

dispose()

属性详细信息

maxParticipantsToSpotlight

返回可聚焦的最大参与者数

maxParticipantsToSpotlight: number

属性值

number

继承属性详细信息

name

功能名称。

name: string

属性值

string

继承自CallFeature.name 的

方法详细信息

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

返回

SpotlightedParticipant[]

返回当前聚焦的所有参与者的列表

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

SpotlightUpdated 事件的订阅函数

function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

参数

event

"spotlightChanged"

事件名称

listener

CollectionUpdatedEvent<SpotlightedParticipant>

用于订阅此事件的回调函数

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

SpotlightUpdated 事件的订阅函数

function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

参数

event

"spotlightChanged"

事件名称

listener

CollectionUpdatedEvent<SpotlightedParticipant>

用于订阅此事件的回调函数

startSpotlight(CommunicationIdentifier[]) 

function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

参数

participants

CommunicationIdentifier[]

在未传递参与者数组时启动本地参与者和远程参与者的聚焦，对本地参与者执行操作

返回

Promise<void>

表示 startParticipantSpotlight 操作完成的 Promise。 成功启动 startParticipantSpotlight 时，将发出“SpotlightUpdated”事件。

stopAllSpotlight()

停止为所有参与者聚焦。

function stopAllSpotlight(): Promise<void>

返回

Promise<void>

表示 stopAllSpotlight 操作完成的 Promise。 当 stopAllSpotlight 已成功停止时，将发出“SpotlightUpdated”事件。

stopSpotlight(CommunicationIdentifier[]) 

function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

参数

participants

CommunicationIdentifier[]

当未传递参与者数组时，停止本地参与者和远程参与者的聚焦，对本地参与者执行操作

返回

Promise<void>

表示 stopParticipantSpotlight 操作完成的 Promise。 当 stopParticipantSpotlight 已成功停止时，将发出“SpotlightUpdated”事件。

继承的方法详细信息

dispose() 

function dispose()

继承自CallFeature.dispose