Compartir a través de

SpotlightCallFeature interface

  • Referencia
Paquete:
@azure/communication-calling

Característica de llamada de Spotlight.

Extends
CallFeature

Propiedades

maxParticipantsToSpotlight

Devuelve el número máximo de participantes que se pueden destacar.

Propiedades heredadas

name

Nombre de la característica.

Métodos

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

Función Subscribe para el evento SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Función Subscribe para el evento SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Detiene la atención de todos los participantes.
stopSpotlight(CommunicationIdentifier[])

Métodos heredados

dispose()

Detalles de las propiedades

maxParticipantsToSpotlight

Devuelve el número máximo de participantes que se pueden destacar.

maxParticipantsToSpotlight: number

Valor de propiedad

number

Detalles de las propiedades heredadas

name

Nombre de la característica.

name: string

Valor de propiedad

string

heredado deCallFeature.name

Detalles del método

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Devoluciones

SpotlightedParticipant[]

Devuelve la lista de todos los participantes actualmente destacados

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Función Subscribe para el evento SpotlightUpdated

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

Parámetros

event

"spotlightChanged"

nombre del evento

listener

CollectionUpdatedEvent<SpotlightedParticipant>

función de devolución de llamada que se usó para suscribirse a este evento

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Función Subscribe para el evento SpotlightUpdated

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

Parámetros

event

"spotlightChanged"

nombre del evento

listener

CollectionUpdatedEvent<SpotlightedParticipant>

función de devolución de llamada que se usó para suscribirse a este evento

startSpotlight(CommunicationIdentifier[]) 

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

Parámetros

participants

CommunicationIdentifier[]

inicia Spotlight para participantes locales y remotos cuando no se pasa la matriz de participantes, se realiza una acción en el participante local.

Devoluciones

Promise<void>

Promesa que representa la finalización de la operación startParticipantSpotlight. Se emitirá un evento "SpotlightUpdated" cuando startParticipantSpotlight se haya iniciado correctamente.

stopAllSpotlight()

Detiene la atención de todos los participantes.

function stopAllSpotlight(): Promise<void>

Devoluciones

Promise<void>

Promesa que representa la finalización de la operación stopAllSpotlight. Se emitirá un evento "SpotlightUpdated" cuando stopAllSpotlight se haya detenido correctamente.

stopSpotlight(CommunicationIdentifier[]) 

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

Parámetros

participants

CommunicationIdentifier[]

detiene Spotlight para participantes locales y remotos cuando no se pasa la matriz de participantes, se realiza una acción en el participante local.

Devoluciones

Promise<void>

Promesa que representa la finalización de la operación stopParticipantSpotlight. Se emitirá un evento "SpotlightUpdated" cuando stopParticipantSpotlight se haya detenido correctamente.

Detalles de los métodos heredados

dispose() 

function dispose()

heredado deCallFeature.dispose