Compartir a través de

RemoteParticipant interface

  • Referencia
Paquete:
@azure/communication-calling

Representa un participante remoto en una llamada.

Extends
ParticipantInfo

Propiedades

callEndReason

Motivo por el que el participante abandonó la llamada, contiene código, subCódigo o mensaje.
isMuted

Si este participante remoto está silenciado o no.
isSpeaking

Si este participante remoto habla o no.
role

Obtenga el rol de este participante remoto.
state

Obtener el estado de este participante remoto.
videoStreams

Colección de secuencias de vídeo que tiene este participante.

Propiedades heredadas

displayName

Nombre para mostrar opcional, si lo estableció el punto de conexión de ese participante remoto.
endpointDetails

Obtener los detalles de todos los puntos de conexión de este participante remoto
identifier

Obtenga el identificador de este participante remoto.

Métodos

mute()

Silenciar el micrófono de este participante remoto.
off("displayNameChanged", PropertyChangedEvent)

Función Cancele la suscripción para el evento displayNameChanged.
off("isMutedChanged", PropertyChangedEvent)

Función Unsubscribe para el evento isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)

Función de cancelación de suscripción para el evento isSpeakingChanged.
off("roleChanged", PropertyChangedEvent)

Cancelar la suscripción de la función para el evento roleChanged.
off("stateChanged", PropertyChangedEvent)

Cancelar la suscripción de la función para el evento stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Cancele la función para el evento videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)

Función Subscribe para el evento displayNameChanged.
on("isMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)

Función Subscribe para el evento isSpeakingChanged.
on("roleChanged", PropertyChangedEvent)

Función Subscribe para el evento roleChanged.
on("stateChanged", PropertyChangedEvent)

Función Subscribe para el evento stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Función Subscribe para el evento videoStreamsUpdated.

Detalles de las propiedades

callEndReason

Motivo por el que el participante abandonó la llamada, contiene código, subCódigo o mensaje.

callEndReason?: CallEndReason

Valor de propiedad

CallEndReason

isMuted

Si este participante remoto está silenciado o no.

isMuted: boolean

Valor de propiedad

boolean

isSpeaking

Si este participante remoto habla o no.

isSpeaking: boolean

Valor de propiedad

boolean

role

Obtenga el rol de este participante remoto.

role: ParticipantRole

Valor de propiedad

ParticipantRole

state

Obtener el estado de este participante remoto.

state: RemoteParticipantState

Valor de propiedad

RemoteParticipantState

videoStreams

Colección de secuencias de vídeo que tiene este participante.

videoStreams: readonly RemoteVideoStream[]

Valor de propiedad

readonly RemoteVideoStream[]

Detalles de las propiedades heredadas

displayName

Nombre para mostrar opcional, si lo estableció el punto de conexión de ese participante remoto.

displayName?: string

Valor de propiedad

string

Heredado deParticipantInfo.displayName

endpointDetails

Obtener los detalles de todos los puntos de conexión de este participante remoto

endpointDetails: EndpointDetails[]

Valor de propiedad

EndpointDetails[]

Heredado deParticipantInfo.endpointDetails

identifier

Obtenga el identificador de este participante remoto.

identifier: CommunicationIdentifierKind

Valor de propiedad

CommunicationIdentifierKind

heredado deParticipantInfo.identifier

Detalles del método

mute()

Silenciar el micrófono de este participante remoto.

function mute(): Promise<void>

Devoluciones

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Función Cancele la suscripción para el evento displayNameChanged.

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

Parámetros

event

"displayNameChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

off("isMutedChanged", PropertyChangedEvent)

Función Unsubscribe para el evento isMutedChanged.

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

Parámetros

event

"isMutedChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

off("isSpeakingChanged", PropertyChangedEvent)

Función de cancelación de suscripción para el evento isSpeakingChanged.

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

Parámetros

event

"isSpeakingChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

off("roleChanged", PropertyChangedEvent)

Cancelar la suscripción de la función para el evento roleChanged.

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

Parámetros

event

"roleChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

off("stateChanged", PropertyChangedEvent)

Cancelar la suscripción de la función para el evento stateChanged.

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

Parámetros

event

"stateChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Cancele la función para el evento videoStreamsUpdated.

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

Parámetros

event

"videoStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn que se usó para suscribirse a este evento.

on("displayNameChanged", PropertyChangedEvent)

Función Subscribe para el evento displayNameChanged.

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

Parámetros

event

"displayNameChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("isMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isMutedChanged.

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

Parámetros

event

"isMutedChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("isSpeakingChanged", PropertyChangedEvent)

Función Subscribe para el evento isSpeakingChanged.

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

Parámetros

event

"isSpeakingChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("roleChanged", PropertyChangedEvent)

Función Subscribe para el evento roleChanged.

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

Parámetros

event

"roleChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("stateChanged", PropertyChangedEvent)

Función Subscribe para el evento stateChanged.

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

Parámetros

event

"stateChanged"

nombre del evento.

listener
PropertyChangedEvent

callback fn al que se llamará cuando cambie el valor de esta propiedad.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Función Subscribe para el evento videoStreamsUpdated.

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

Parámetros

event

"videoStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn al que se llamará cuando cambie esta colección, pasará matrices de elementos agregados y quitados.