Udostępnij za pośrednictwem

SpotlightCallFeature interface

  • Odwołanie
Pakiet:
@azure/communication-calling

Funkcja wywołania W centrum uwagi.

Rozszerzenie
CallFeature

Właściwości

maxParticipantsToSpotlight

Zwraca maksymalną liczbę uczestników, które mogą być w centrum uwagi

Właściwości dziedziczone

name

Nazwa funkcji.

Metody

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

Funkcja subskrybuj zdarzenie SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Funkcja subskrybuj zdarzenie SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Zatrzymuje W centrum uwagi dla wszystkich uczestników.
stopSpotlight(CommunicationIdentifier[])

Metody dziedziczone

dispose()

Szczegóły właściwości

maxParticipantsToSpotlight

Zwraca maksymalną liczbę uczestników, które mogą być w centrum uwagi

maxParticipantsToSpotlight: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

name

Nazwa funkcji.

name: string

Wartość właściwości

string

dziedziczone zCallFeature.name

Szczegóły metody

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Zwraca

SpotlightedParticipant[]

Zwraca listę wszystkich uczestników aktualnie w centrum uwagi

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Funkcja subskrybuj zdarzenie SpotlightUpdated

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

Parametry

event

"spotlightChanged"

nazwa zdarzenia

listener

CollectionUpdatedEvent<SpotlightedParticipant>

funkcja wywołania zwrotnego, która została użyta do subskrybowania tego zdarzenia

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Funkcja subskrybuj zdarzenie SpotlightUpdated

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

Parametry

event

"spotlightChanged"

nazwa zdarzenia

listener

CollectionUpdatedEvent<SpotlightedParticipant>

funkcja wywołania zwrotnego, która została użyta do subskrybowania tego zdarzenia

startSpotlight(CommunicationIdentifier[]) 

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

Parametry

participants

CommunicationIdentifier[]

uruchamia w centrum uwagi dla uczestników lokalnych i zdalnych, gdy tablica uczestników nie jest przekazywana, akcja jest wykonywana na uczestniku lokalnym

Zwraca

Promise<void>

Obietnica reprezentująca zakończenie operacji startParticipantSpotlight. Zdarzenie "SpotlightUpdated" będzie emitowane po pomyślnym uruchomieniu elementu startParticipantSpotlight.

stopAllSpotlight()

Zatrzymuje W centrum uwagi dla wszystkich uczestników.

function stopAllSpotlight(): Promise<void>

Zwraca

Promise<void>

Obietnica reprezentująca zakończenie operacji stopAllSpotlight. Zdarzenie "SpotlightUpdated" będzie emitowane po pomyślnym zatrzymaniu stopAllSpotlight.

stopSpotlight(CommunicationIdentifier[]) 

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

Parametry

participants

CommunicationIdentifier[]

zatrzymuje w centrum uwagi dla uczestników lokalnych i zdalnych, gdy tablica uczestników nie jest przekazywana, akcja jest wykonywana na uczestniku lokalnym

Zwraca

Promise<void>

Obietnica reprezentująca zakończenie operacji stopParticipantSpotlight. Zdarzenie "SpotlightUpdated" będzie emitowane po pomyślnym zatrzymaniu stopParticipantSpotlight.

Szczegóły metody dziedziczonej

dispose() 

function dispose()

dziedziczone zCallFeature.dispose