共用方式為

SpotlightCallFeature interface

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

焦點通話功能。

Extends
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>

用來訂閱此事件的 callback 函式

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

SpotlightUpdated 事件的訂閱函式

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

參數

event

"spotlightChanged"

事件名稱

listener

CollectionUpdatedEvent<SpotlightedParticipant>

用來訂閱此事件的 callback 函式

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