Sdílet prostřednictvím

SpotlightCallFeature interface

  • Reference
Balíček:
@azure/communication-calling

Funkce spotlight volání.

Extends
CallFeature

Vlastnosti

maxParticipantsToSpotlight

Vrátí maximální počet účastníků, kteří mohou být vybraní.

Zděděné vlastnosti

name

Název funkce.

Metody

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

Přihlásit se k události SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Přihlásit se k události SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Přestane zobrazovat vybrané položky pro všechny účastníky.
stopSpotlight(CommunicationIdentifier[])

Zděděné metody

dispose()

Podrobnosti vlastnosti

maxParticipantsToSpotlight

Vrátí maximální počet účastníků, kteří mohou být vybraní.

maxParticipantsToSpotlight: number

Hodnota vlastnosti

number

Podrobnosti zděděných vlastností

name

Název funkce.

name: string

Hodnota vlastnosti

string

Zděděno zCallFeature.name

Podrobnosti metody

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Návraty

SpotlightedParticipant[]

Vrátí seznam všech aktuálně zvýrazněných účastníků.

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Přihlásit se k události SpotlightUpdated

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

Parametry

event

"spotlightChanged"

název události

listener

CollectionUpdatedEvent<SpotlightedParticipant>

funkce zpětného volání, která se použila k přihlášení k odběru této události

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Přihlásit se k události SpotlightUpdated

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

Parametry

event

"spotlightChanged"

název události

listener

CollectionUpdatedEvent<SpotlightedParticipant>

funkce zpětného volání, která se použila k přihlášení k odběru této události

startSpotlight(CommunicationIdentifier[]) 

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

Parametry

participants

CommunicationIdentifier[]

Spustí spotlight pro místní a vzdálené účastníky, když pole účastníků není předáno, akce se provede u místního účastníka.

Návraty

Promise<void>

Příslib představující dokončení operace startParticipantSpotlight. Událost SpotlightUpdated se vygeneruje po úspěšném spuštění startParticipantSpotlight.

stopAllSpotlight()

Přestane zobrazovat vybrané položky pro všechny účastníky.

function stopAllSpotlight(): Promise<void>

Návraty

Promise<void>

Příslib představující dokončení operace stopAllSpotlight. Událost SpotlightUpdated se vygeneruje po úspěšném zastavení stopAllSpotlight.

stopSpotlight(CommunicationIdentifier[]) 

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

Parametry

participants

CommunicationIdentifier[]

zastaví spotlight pro místní a vzdálené účastníky, když pole účastníků není předáno, akce se provede u místního účastníka.

Návraty

Promise<void>

Příslib představující dokončení operace stopParticipantSpotlight. Událost SpotlightUpdated se vygeneruje, když se funkce stopParticipantSpotlight úspěšně zastavila.

Podrobnosti zděděných metod

dispose() 

function dispose()

Zděděno zCallFeature.dispose