Partilhar via

RemoteParticipant interface

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

Representa um participante remoto numa chamada.

Extends
ParticipantInfo

Propriedades

callEndReason

Motivo pelo qual o participante saiu da chamada, contém código/subCódigo/mensagem.
isMuted

Se este participante remoto está ou não sem som.
isSpeaking

Quer este participante remoto esteja a falar ou não.
role

Obtenha a função deste participante remoto.
state

Obtenha o estado deste participante remoto.
videoStreams

Coleção de transmissões de vídeo que estes participantes têm.

Propriedades Herdadas

displayName

Nome a apresentar opcional, se tiver sido definido pelo ponto final desse participante remoto.
endpointDetails

Obter os detalhes de todos os pontos finais deste participante remoto
identifier

Obtenha o identificador deste participante remoto.

Métodos

mute()

Desativar o som do microfone deste participante remoto.
off("displayNameChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento displayNameChanged.
off("isMutedChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento isSpeakingChanged.
off("roleChanged", PropertyChangedEvent)

Anule a subscrição da função Evento roleChanged.
off("stateChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Anule a subscrição da função para o evento videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)

Subscreva a função para o evento displayNameChanged.
on("isMutedChanged", PropertyChangedEvent)

Subscreva a função para o evento isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)

Subscreva a função para o evento isSpeakingChanged.
on("roleChanged", PropertyChangedEvent)

Subscreva a função para o evento roleChanged.
on("stateChanged", PropertyChangedEvent)

Subscreva a função para o evento stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Função Subscribe para o evento videoStreamsUpdated.

Detalhes de Propriedade

callEndReason

Motivo pelo qual o participante saiu da chamada, contém código/subCódigo/mensagem.

callEndReason?: CallEndReason

Valor de Propriedade

CallEndReason

isMuted

Se este participante remoto está ou não sem som.

isMuted: boolean

Valor de Propriedade

boolean

isSpeaking

Quer este participante remoto esteja a falar ou não.

isSpeaking: boolean

Valor de Propriedade

boolean

role

Obtenha a função deste participante remoto.

role: ParticipantRole

Valor de Propriedade

ParticipantRole

state

Obtenha o estado deste participante remoto.

state: RemoteParticipantState

Valor de Propriedade

RemoteParticipantState

videoStreams

Coleção de transmissões de vídeo que estes participantes têm.

videoStreams: ReadonlyArray<RemoteVideoStream>

Valor de Propriedade

ReadonlyArray<RemoteVideoStream>

Detalhes da Propriedade Herdada

displayName

Nome a apresentar opcional, se tiver sido definido pelo ponto final desse participante remoto.

displayName?: string

Valor de Propriedade

string

Herdado deParticipantInfo.displayName

endpointDetails

Obter os detalhes de todos os pontos finais deste participante remoto

endpointDetails: EndpointDetails[]

Valor de Propriedade

EndpointDetails[]

Herdado deParticipantInfo.endpointDetails

identifier

Obtenha o identificador deste participante remoto.

identifier: CommunicationIdentifierKind

Valor de Propriedade

CommunicationIdentifierKind

Herdado deParticipantInfo.identifier

Detalhes de Método

mute()

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Desativar o som do microfone deste participante remoto.

function mute(): Promise<void>

Devoluções

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento displayNameChanged.

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

Parâmetros

event

"displayNameChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que foi utilizado para subscrever este evento.

off("isMutedChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento isMutedChanged.

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

Parâmetros

event

"isMutedChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que foi utilizado para subscrever este evento.

off("isSpeakingChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento isSpeakingChanged.

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

Parâmetros

event

"isSpeakingChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que foi utilizado para subscrever este evento.

off("roleChanged", PropertyChangedEvent)

Anule a subscrição da função Evento roleChanged.

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

Parâmetros

event

"roleChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que foi utilizado para subscrever este evento.

off("stateChanged", PropertyChangedEvent)

Anule a subscrição da função para o evento stateChanged.

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

Parâmetros

event

"stateChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que foi utilizado para subscrever este evento.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Anule a subscrição da função para o evento videoStreamsUpdated.

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

Parâmetros

event

"videoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn que foi utilizado para subscrever este evento.

on("displayNameChanged", PropertyChangedEvent)

Subscreva a função para o evento displayNameChanged.

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

Parâmetros

event

"displayNameChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que será chamado quando o valor desta propriedade for alterado.

on("isMutedChanged", PropertyChangedEvent)

Subscreva a função para o evento isMutedChanged.

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

Parâmetros

event

"isMutedChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que será chamado quando o valor desta propriedade for alterado.

on("isSpeakingChanged", PropertyChangedEvent)

Subscreva a função para o evento isSpeakingChanged.

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

Parâmetros

event

"isSpeakingChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que será chamado quando o valor desta propriedade for alterado.

on("roleChanged", PropertyChangedEvent)

Subscreva a função para o evento roleChanged.

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

Parâmetros

event

"roleChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que será chamado quando o valor desta propriedade for alterado.

on("stateChanged", PropertyChangedEvent)

Subscreva a função para o evento stateChanged.

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

Parâmetros

event

"stateChanged"

nome do evento.

listener
PropertyChangedEvent

callback fn que será chamado quando o valor desta propriedade for alterado.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Função Subscribe para o evento videoStreamsUpdated.

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

Parâmetros

event

"videoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

fn de chamada de retorno que será chamada quando esta coleção for alterada, transmitirá matrizes de elementos adicionados e removidos.