SpotlightCallFeature interface

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

maxParticipantsToSpotlight: number

属性值

功能名称。

name: string

属性值

继承自CallFeature.name 的

function getSpotlightedParticipants(): SpotlightedParticipant[]

返回

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

SpotlightUpdated 事件的订阅函数

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

参数

SpotlightUpdated 事件的订阅函数

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

参数

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

参数

返回

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

停止为所有参与者聚焦。

function stopAllSpotlight(): Promise<void>

返回

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

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

参数

返回

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

function dispose()

继承自CallFeature.dispose