Freigeben über

SpotlightCallFeature interface

  • Referenz
Paket:
@azure/communication-calling

Spotlight-Anruffunktion.

Extends
CallFeature

Eigenschaften

maxParticipantsToSpotlight

Gibt die maximale Anzahl von Teilnehmern zurück, die spotlighted werden können.

Geerbte Eigenschaften

name

Der Featurename.

Methoden

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

Subscribe-Funktion für spotlightUpdated-Ereignis
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Subscribe-Funktion für spotlightUpdated-Ereignis
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Stoppt spotlighting für alle Teilnehmer.
stopSpotlight(CommunicationIdentifier[])

Geerbte Methoden

dispose()

Details zur Eigenschaft

maxParticipantsToSpotlight

Gibt die maximale Anzahl von Teilnehmern zurück, die spotlighted werden können.

maxParticipantsToSpotlight: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

name

Der Featurename.

name: string

Eigenschaftswert

string

geerbt vonCallFeature.name

Details zur Methode

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Gibt zurück

SpotlightedParticipant[]

Gibt die Liste aller Teilnehmer zurück, die derzeit spotlighted sind.

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Subscribe-Funktion für spotlightUpdated-Ereignis

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

Parameter

event

"spotlightChanged"

Ereignisname

listener

CollectionUpdatedEvent<SpotlightedParticipant>

Rückruffunktion, die zum Abonnieren dieses Ereignisses verwendet wurde

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Subscribe-Funktion für spotlightUpdated-Ereignis

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

Parameter

event

"spotlightChanged"

Ereignisname

listener

CollectionUpdatedEvent<SpotlightedParticipant>

Rückruffunktion, die zum Abonnieren dieses Ereignisses verwendet wurde

startSpotlight(CommunicationIdentifier[]) 

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

Parameter

participants

CommunicationIdentifier[]

startet Spotlight für lokale und Remoteteilnehmer, wenn das Teilnehmerarray nicht übergeben wird, wird die Aktion für lokale Teilnehmer ausgeführt.

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des startParticipantSpotlight-Vorgangs darstellt. Ein "SpotlightUpdated"-Ereignis wird ausgegeben, wenn startParticipantSpotlight erfolgreich gestartet wurde.

stopAllSpotlight()

Stoppt spotlighting für alle Teilnehmer.

function stopAllSpotlight(): Promise<void>

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des stopAllSpotlight-Vorgangs darstellt. Ein "SpotlightUpdated"-Ereignis wird ausgegeben, wenn stopAllSpotlight erfolgreich beendet wurde.

stopSpotlight(CommunicationIdentifier[]) 

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

Parameter

participants

CommunicationIdentifier[]

stoppt Spotlight für lokale und Remoteteilnehmer, wenn das Teilnehmerarray nicht übergeben wird, wird die Aktion für lokale Teilnehmer ausgeführt.

Gibt zurück

Promise<void>

Eine Zusage, die den Abschluss des stopParticipantSpotlight-Vorgangs darstellt. Ein "SpotlightUpdated"-Ereignis wird ausgegeben, wenn stopParticipantSpotlight erfolgreich beendet wurde.

Details zur geerbten Methode

dispose() 

function dispose()

geerbt vonCallFeature.dispose