RemoteParticipant interface
Representa um participante remoto em uma chamada.
- Extends
Propriedades
| call |
Motivo pelo qual o participante deixou a chamada, contém código/subcódigo/mensagem. |
| is |
Se este participante remoto está mudo ou não. |
| is |
Se este participante remoto está falando ou não. |
| role | Obtenha o papel deste participante remoto. |
| state | Obtenha o estado deste participante remoto. |
| video |
Coleção de fluxos de vídeo que este participante tem. |
Propriedades Herdadas
| display |
Nome de exibição opcional, se tiver sido definido pelo ponto de extremidade desse participante remoto. |
| endpoint |
Obtenha os detalhes de todos os endpoints para este participante remoto |
| identifier | Obtenha o identificador para este participante remoto. |
Métodos
| mute() | Silencie o microfone deste participante remoto. |
| off("display |
Função de cancelamento de inscrição para o evento displayNameChanged. |
| off("is |
Função de cancelamento de inscrição para o evento isMutedChanged. |
| off("is |
Função de cancelamento de inscrição para o evento isSpeakingChanged. |
| off("role |
Função de cancelamento de inscrição para o evento roleChanged. |
| off("state |
Função de cancelamento de inscrição para o evento stateChanged. |
| off("video |
Função de cancelamento de inscrição para o evento videoStreamsUpdated. |
| on("display |
Função Subscribe para o evento displayNameChanged. |
| on("is |
Função Subscribe para o evento isMutedChanged. |
| on("is |
Função de assinatura para o evento isSpeakingChanged. |
| on("role |
Função Subscribe para o evento roleChanged. |
| on("state |
Função Subscribe para o evento stateChanged. |
| on("video |
Função de inscrição para o evento videoStreamsUpdated. |
Detalhes de Propriedade
callEndReason
Motivo pelo qual o participante deixou a chamada, contém código/subcódigo/mensagem.
callEndReason?: CallEndReasonValor de Propriedade
isMuted
Se este participante remoto está mudo ou não.
isMuted: booleanValor de Propriedade
boolean
isSpeaking
Se este participante remoto está falando ou não.
isSpeaking: booleanValor de Propriedade
boolean
role
Obtenha o papel deste participante remoto.
role: ParticipantRoleValor de Propriedade
state
Obtenha o estado deste participante remoto.
state: RemoteParticipantStateValor de Propriedade
videoStreams
Coleção de fluxos de vídeo que este participante tem.
videoStreams: readonly RemoteVideoStream[]Valor de Propriedade
readonly RemoteVideoStream[]
Detalhes da Propriedade Herdada
displayName
Nome de exibição opcional, se tiver sido definido pelo ponto de extremidade desse participante remoto.
displayName?: stringValor de Propriedade
string
herdado deParticipantInfo.displayName
endpointDetails
Obtenha os detalhes de todos os endpoints para este participante remoto
endpointDetails: EndpointDetails[]Valor de Propriedade
herdado deParticipantInfo.endpointDetails
identifier
Obtenha o identificador para este participante remoto.
identifier: CommunicationIdentifierKindValor de Propriedade
Detalhes de Método
mute()
Silencie o microfone deste participante remoto.
function mute(): Promise<void>Devoluções
Promise<void>
off("displayNameChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para o evento displayNameChanged.
function off(event: "displayNameChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"displayNameChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento.
off("isMutedChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para o evento isMutedChanged.
function off(event: "isMutedChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"isMutedChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento.
off("isSpeakingChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para o evento isSpeakingChanged.
function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"isSpeakingChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento.
off("roleChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para o evento roleChanged.
function off(event: "roleChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"roleChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento.
off("stateChanged", PropertyChangedEvent)
Função de cancelamento de inscrição para o evento stateChanged.
function off(event: "stateChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"stateChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que foi usado para se inscrever neste evento.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Função de cancelamento de inscrição para o evento videoStreamsUpdated.
function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Parâmetros
- event
-
"videoStreamsUpdated"
nome do evento.
- listener
retorno de chamada fn que foi usado para se inscrever neste evento.
on("displayNameChanged", PropertyChangedEvent)
Função Subscribe para o evento displayNameChanged.
function on(event: "displayNameChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"displayNameChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.
on("isMutedChanged", PropertyChangedEvent)
Função Subscribe para o evento isMutedChanged.
function on(event: "isMutedChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"isMutedChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.
on("isSpeakingChanged", PropertyChangedEvent)
Função de assinatura para o evento isSpeakingChanged.
function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"isSpeakingChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.
on("roleChanged", PropertyChangedEvent)
Função Subscribe para o evento roleChanged.
function on(event: "roleChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"roleChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.
on("stateChanged", PropertyChangedEvent)
Função Subscribe para o evento stateChanged.
function on(event: "stateChanged", listener: PropertyChangedEvent)Parâmetros
- event
-
"stateChanged"
nome do evento.
- listener
- PropertyChangedEvent
retorno de chamada fn que será chamado quando o valor dessa propriedade for alterado.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Função de inscrição para o evento videoStreamsUpdated.
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Parâmetros
- event
-
"videoStreamsUpdated"
nome do evento.
- listener
retorno de chamada fn que será chamado quando essa coleção for alterada, ele passará matrizes de elementos adicionados e removidos.