Partager via

SpotlightCallFeature interface

  • Référence
Paquet:
@azure/communication-calling

Fonctionnalité d’appel à la une.

Extends
CallFeature

Propriétés

maxParticipantsToSpotlight

Retourne le nombre maximal de participants pouvant être mis à la une

Propriétés héritées

name

Nom de la fonctionnalité.

Méthodes

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

Fonction Subscribe pour l’événement SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Fonction Subscribe pour l’événement SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Arrête la mise à l’honneur pour tous les participants.
stopSpotlight(CommunicationIdentifier[])

Méthodes héritées

dispose()

Détails de la propriété

maxParticipantsToSpotlight

Retourne le nombre maximal de participants pouvant être mis à la une

maxParticipantsToSpotlight: number

Valeur de propriété

number

Détails de la propriété héritée

name

Nom de la fonctionnalité.

name: string

Valeur de propriété

string

héritée deCallFeature.name

Détails de la méthode

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Retours

SpotlightedParticipant[]

Renvoie la liste de tous les participants actuellement à la une

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Fonction Subscribe pour l’événement SpotlightUpdated

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

Paramètres

event

"spotlightChanged"

nom de l’événement

listener

CollectionUpdatedEvent<SpotlightedParticipant>

fonction de rappel utilisée pour s’abonner à cet événement

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Fonction Subscribe pour l’événement SpotlightUpdated

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

Paramètres

event

"spotlightChanged"

nom de l’événement

listener

CollectionUpdatedEvent<SpotlightedParticipant>

fonction de rappel utilisée pour s’abonner à cet événement

startSpotlight(CommunicationIdentifier[]) 

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

Paramètres

participants

CommunicationIdentifier[]

démarre Spotlight pour les participants locaux et distants lorsque le tableau des participants n’est pas passé, l’action est effectuée sur un participant local

Retours

Promise<void>

Promesse représentant l’achèvement de l’opération startParticipantSpotlight. Un événement « SpotlightUpdated » est émis lorsque startParticipantSpotlight a démarré avec succès.

stopAllSpotlight()

Arrête la mise à l’honneur pour tous les participants.

function stopAllSpotlight(): Promise<void>

Retours

Promise<void>

Promesse représentant l’achèvement de l’opération stopAllSpotlight. Un événement « SpotlightUpdated » est émis lorsque stopAllSpotlight a réussi à s’arrêter.

stopSpotlight(CommunicationIdentifier[]) 

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

Paramètres

participants

CommunicationIdentifier[]

arrête Spotlight pour les participants locaux et distants lorsque le tableau des participants n’est pas passé, l’action est effectuée sur un participant local

Retours

Promise<void>

Promesse représentant l’achèvement de l’opération stopParticipantSpotlight. Un événement « SpotlightUpdated » est émis lorsque stopParticipantSpotlight a réussi à s’arrêter.

Détails de la méthode héritée

dispose() 

function dispose()

héritée deCallFeature.dispose