RemoteParticipant interface

Pacote:

@azure/communication-calling

Representa um participante remoto em uma chamada.

Extends

ParticipantInfo

Propriedades

callEndReason	Motivo pelo qual o participante deixou a chamada, contém código/subCode/mensagem.
isMuted	Se esse participante remoto está mudo ou não.
isSpeaking	Se esse participante remoto está falando ou não.
role	Obtenha a função desse participante remoto.
state	Obtenha o estado desse participante remoto.
videoStreams	Coleção de fluxos de vídeo que esses participantes têm.

Propriedades herdadas

displayName	Nome de exibição opcional, se ele foi definido pelo ponto de extremidade desse participante remoto.
endpointDetails	Obter os detalhes de todos os pontos de extremidade para este participante remoto
identifier	Obtenha o identificador deste participante remoto.

Métodos

mute()	Silencie o microfone desse participante remoto.
off("displayNameChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento displayNameChanged.
off("isMutedChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento isSpeakingChanged.
off("roleChanged", PropertyChangedEvent)	Cancelar a assinatura da função de evento roleChanged.
off("stateChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	Função Cancelar assinatura do evento videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)	Função Subscribe para o evento displayNameChanged.
on("isMutedChanged", PropertyChangedEvent)	Função de assinatura do evento isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)	Função de assinatura do evento isSpeakingChanged.
on("roleChanged", PropertyChangedEvent)	Função Subscribe para evento roleChanged.
on("stateChanged", PropertyChangedEvent)	Função de assinatura do evento stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	Função de assinatura do evento videoStreamsUpdated.

Detalhes da propriedade

callEndReason

Motivo pelo qual o participante deixou a chamada, contém código/subCode/mensagem.

callEndReason?: CallEndReason

Valor da propriedade

CallEndReason

isMuted

Se esse participante remoto está mudo ou não.

isMuted: boolean

Valor da propriedade

boolean

isSpeaking

Se esse participante remoto está falando ou não.

isSpeaking: boolean

Valor da propriedade

boolean

role

Obtenha a função desse participante remoto.

role: ParticipantRole

Valor da propriedade

ParticipantRole

state

Obtenha o estado desse participante remoto.

state: RemoteParticipantState

Valor da propriedade

RemoteParticipantState

videoStreams

Coleção de fluxos de vídeo que esses participantes têm.

videoStreams: readonly RemoteVideoStream[]

Valor da propriedade

readonly RemoteVideoStream[]

Detalhes das propriedades herdadas

displayName

Nome de exibição opcional, se ele foi definido pelo ponto de extremidade desse participante remoto.

displayName?: string

Valor da propriedade

string

herdado de ParticipantInfo.displayName

endpointDetails

Obter os detalhes de todos os pontos de extremidade para este participante remoto

endpointDetails: EndpointDetails[]

Valor da propriedade

EndpointDetails[]

Herdado deParticipantInfo.endpointDetails

identifier

Obtenha o identificador deste participante remoto.

identifier: CommunicationIdentifierKind

Valor da propriedade

CommunicationIdentifierKind

Herdado deParticipantInfo.identifier

Detalhes do método

mute()

Silencie o microfone desse participante remoto.

function mute(): Promise<void>

Retornos

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento displayNameChanged.

function off(event: "displayNameChanged", listener: PropertyChangedEvent)

Parâmetros

event

"displayNameChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

off("isMutedChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento isMutedChanged.

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

off("isSpeakingChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento isSpeakingChanged.

function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isSpeakingChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

off("roleChanged", PropertyChangedEvent)

Cancelar a assinatura da função de evento roleChanged.

function off(event: "roleChanged", listener: PropertyChangedEvent)

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

off("stateChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento stateChanged.

function off(event: "stateChanged", listener: PropertyChangedEvent)

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Função Cancelar assinatura do evento videoStreamsUpdated.

function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)

Parâmetros

event

"videoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

fn de retorno de chamada que foi usado para assinar este 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

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

on("isMutedChanged", PropertyChangedEvent)

Função de assinatura do evento isMutedChanged.

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

on("isSpeakingChanged", PropertyChangedEvent)

Função de assinatura do evento isSpeakingChanged.

function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isSpeakingChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

on("roleChanged", PropertyChangedEvent)

Função Subscribe para evento roleChanged.

function on(event: "roleChanged", listener: PropertyChangedEvent)

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

on("stateChanged", PropertyChangedEvent)

Função de assinatura do evento stateChanged.

function on(event: "stateChanged", listener: PropertyChangedEvent)

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Função de assinatura do evento videoStreamsUpdated.

function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)

Parâmetros

event

"videoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

fn de retorno de chamada que será chamado quando essa coleção for alterada, ela passará matrizes de elementos adicionados e removidos.