SpotlightCallFeature interface
Funzionalità di chiamata Spotlight.
- Extends
Proprietà
| max |
Restituisce il numero massimo di partecipanti che possono essere contenuti in evidenza |
Proprietà ereditate
| name | Nome della funzionalità. |
Metodi
| get |
|
| off("spotlight |
Funzione Subscribe per l'evento SpotlightUpdated |
| on("spotlight |
Funzione Subscribe per l'evento SpotlightUpdated |
| start |
|
| stop |
Arresta la messa in evidenza per tutti i partecipanti. |
| stop |
Metodi ereditati
| dispose() |
Dettagli proprietà
maxParticipantsToSpotlight
Restituisce il numero massimo di partecipanti che possono essere contenuti in evidenza
maxParticipantsToSpotlight: numberValore della proprietà
number
Dettagli proprietà ereditate
name
Dettagli metodo
getSpotlightedParticipants()
function getSpotlightedParticipants(): SpotlightedParticipant[]Restituisce
Restituisce l'elenco di tutti i partecipanti attualmente in evidenza
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
Funzione Subscribe per l'evento SpotlightUpdated
function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)Parametri
- event
-
"spotlightChanged"
nome evento
- listener
funzione di callback usata per sottoscrivere questo evento
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
Funzione Subscribe per l'evento SpotlightUpdated
function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)Parametri
- event
-
"spotlightChanged"
nome evento
- listener
funzione di callback usata per sottoscrivere questo evento
startSpotlight(CommunicationIdentifier[])
function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>Parametri
- participants
avvia Spotlight per i partecipanti locali e remoti quando la matrice di partecipanti non viene passata, l'azione viene eseguita sul partecipante locale
Restituisce
Promise<void>
Promessa che rappresenta il completamento dell'operazione startParticipantSpotlight. All'avvio di startParticipantSpotlight verrà generato un evento 'SpotlightUpdated'.
stopAllSpotlight()
Arresta la messa in evidenza per tutti i partecipanti.
function stopAllSpotlight(): Promise<void>Restituisce
Promise<void>
Promessa che rappresenta il completamento dell'operazione stopAllSpotlight. Un evento 'SpotlightUpdated' verrà generato quando stopAllSpotlight è stato arrestato correttamente.
stopSpotlight(CommunicationIdentifier[])
function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>Parametri
- participants
arresta Spotlight per i partecipanti locali e remoti quando la matrice di partecipanti non viene passata, l'azione viene eseguita sul partecipante locale
Restituisce
Promise<void>
Promessa che rappresenta il completamento dell'operazione stopParticipantSpotlight. Un evento 'SpotlightUpdated' verrà generato quando stopParticipantSpotlight è stato arrestato correttamente.
Dettagli dei metodi ereditati
dispose()
function dispose()Ereditato daCallFeature.dispose