SpotlightCallFeature interface
Recurso de chamada de destaque.
- Extends
Propriedades
max |
Retorna o número máximo de participantes que podem ser destaque |
Propriedades herdadas
name | O nome do recurso. |
Métodos
get |
|
off("spotlight |
Função de assinatura do evento SpotlightUpdated |
on("spotlight |
Função de assinatura do evento SpotlightUpdated |
start |
|
stop |
Interrompe o destaque para todos os participantes. |
stop |
Métodos herdados
dispose() |
Detalhes da propriedade
maxParticipantsToSpotlight
Retorna o número máximo de participantes que podem ser destaque
maxParticipantsToSpotlight: number
Valor da propriedade
number
Detalhes das propriedades herdadas
name
Detalhes do método
getSpotlightedParticipants()
function getSpotlightedParticipants(): SpotlightedParticipant[]
Retornos
Retorna a lista de todos os participantes atualmente em destaque
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
Função de assinatura do evento SpotlightUpdated
function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)
Parâmetros
- event
-
"spotlightChanged"
nome do evento
- listener
função de retorno de chamada que foi usada para assinar este evento
on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)
Função de assinatura do evento SpotlightUpdated
function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)
Parâmetros
- event
-
"spotlightChanged"
nome do evento
- listener
função de retorno de chamada que foi usada para assinar este evento
startSpotlight(CommunicationIdentifier[])
function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>
Parâmetros
- participants
inicia o Destaque para participantes locais e remotos quando a matriz de participantes não é passada, a ação é executada no participante local
Retornos
Promise<void>
Uma promessa que representa a conclusão da operação startParticipantSpotlight. Um evento 'SpotlightUpdated' será emitido quando startParticipantSpotlight tiver sido iniciado com êxito.
stopAllSpotlight()
Interrompe o destaque para todos os participantes.
function stopAllSpotlight(): Promise<void>
Retornos
Promise<void>
Uma promessa que representa a conclusão da operação stopAllSpotlight. Um evento 'SpotlightUpdated' será emitido quando stopAllSpotlight tiver sido interrompido com êxito.
stopSpotlight(CommunicationIdentifier[])
function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>
Parâmetros
- participants
interrompe o Destaque para participantes locais e remotos quando a matriz de participantes não é passada, a ação é executada no participante local
Retornos
Promise<void>
Uma promessa que representa a conclusão da operação stopParticipantSpotlight. Um evento 'SpotlightUpdated' será emitido quando stopParticipantSpotlight tiver sido interrompido com êxito.
Detalhes do método herdado
dispose()
function dispose()
Herdado deCallFeature.dispose