Partilhar via

SpotlightCallFeature interface

  • Referência
Pacote:
@azure/communication-calling

Recurso de chamada do Spotlight.

Extends
CallFeature

Propriedades

maxParticipantsToSpotlight

Devolve o número máximo de participantes que podem ser destacados

Propriedades Herdadas

name

O nome do recurso.

Métodos

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

Função de inscrição para o evento SpotlightUpdated
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Função de inscrição para o evento SpotlightUpdated
startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Para de destacar para todos os participantes.
stopSpotlight(CommunicationIdentifier[])

Métodos Herdados

dispose()

Detalhes de Propriedade

maxParticipantsToSpotlight

Devolve o número máximo de participantes que podem ser destacados

maxParticipantsToSpotlight: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

name

O nome do recurso.

name: string

Valor de Propriedade

string

herdado deCallFeature.name

Detalhes de Método

getSpotlightedParticipants() 

function getSpotlightedParticipants(): SpotlightedParticipant[]

Devoluções

SpotlightedParticipant[]

Devolve a lista de todos os participantes atualmente em destaque

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Função de inscrição para o evento SpotlightUpdated

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

Parâmetros

event

"spotlightChanged"

Nome do evento

listener

CollectionUpdatedEvent<SpotlightedParticipant>

função de retorno de chamada que foi utilizada para subscrever este evento

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Função de inscrição para o evento SpotlightUpdated

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

Parâmetros

event

"spotlightChanged"

Nome do evento

listener

CollectionUpdatedEvent<SpotlightedParticipant>

função de retorno de chamada que foi utilizada para subscrever este evento

startSpotlight(CommunicationIdentifier[]) 

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

Parâmetros

participants

CommunicationIdentifier[]

inicia o Spotlight para participantes locais e remotos quando a matriz de participantes não é aprovada, a ação é executada no participante local

Devoluções

Promise<void>

Uma promessa que representa a conclusão da operação startParticipantSpotlight. Um evento 'SpotlightUpdated' será emitido quando o startParticipantSpotlight tiver começado com sucesso.

stopAllSpotlight()

Para de destacar para todos os participantes.

function stopAllSpotlight(): Promise<void>

Devoluções

Promise<void>

Uma promessa que representa a conclusão da operação stopAllSpotlight. Um evento 'SpotlightUpdated' será emitido quando stopAllSpotlight tiver parado com sucesso.

stopSpotlight(CommunicationIdentifier[]) 

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

Parâmetros

participants

CommunicationIdentifier[]

para o Spotlight para participantes locais e remotos quando a matriz de participantes não é aprovada, a ação é executada no participante local

Devoluções

Promise<void>

Uma promessa que representa a conclusão da operação stopParticipantSpotlight. Um evento 'SpotlightUpdated' será emitido quando stopParticipantSpotlight tiver parado com sucesso.

Detalhes do Método Herdado

dispose() 

function dispose()

herdado deCallFeature.dispose