Share via

RemoteParticipant interface

  • Référence
Paquet:
@azure/communication-calling

Représente un participant distant dans un appel.

Extends
ParticipantInfo

Propriétés

callEndReason

Raison pour laquelle le participant a quitté l’appel, contient code/sous-code/message.
isMuted

Indique si ce participant distant est désactivé ou non.
isSpeaking

Indique si ce participant distant parle ou non.
role

Obtenez le rôle de ce participant distant.
state

Obtenez l’état de ce participant distant.
videoStreams

Collection de flux vidéo que les participants ont.

Propriétés héritées

displayName

Nom complet facultatif, s’il a été défini par le point de terminaison de ce participant distant.
endpointDetails

Obtenir les détails de tous les points de terminaison pour ce participant distant
identifier

Obtenez l’identificateur de ce participant distant.

Méthodes

mute()

Désactiver le micro de ce participant distant.
off("displayNameChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement displayNameChanged.
off("isMutedChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isSpeakingChanged.
off("roleChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement roleChanged.
off("stateChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Fonction de désabonnement pour l’événement videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement displayNameChanged.
on("isMutedChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement isSpeakingChanged.
on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement roleChanged.
on("stateChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Fonction d’abonnement pour l’événement videoStreamsUpdated.

Détails de la propriété

callEndReason

Raison pour laquelle le participant a quitté l’appel, contient code/sous-code/message.

callEndReason?: CallEndReason

Valeur de propriété

CallEndReason

isMuted

Indique si ce participant distant est désactivé ou non.

isMuted: boolean

Valeur de propriété

boolean

isSpeaking

Indique si ce participant distant parle ou non.

isSpeaking: boolean

Valeur de propriété

boolean

role

Obtenez le rôle de ce participant distant.

role: ParticipantRole

Valeur de propriété

ParticipantRole

state

Obtenez l’état de ce participant distant.

state: RemoteParticipantState

Valeur de propriété

RemoteParticipantState

videoStreams

Collection de flux vidéo que les participants ont.

videoStreams: ReadonlyArray<RemoteVideoStream>

Valeur de propriété

ReadonlyArray<RemoteVideoStream>

Détails de la propriété héritée

displayName

Nom complet facultatif, s’il a été défini par le point de terminaison de ce participant distant.

displayName?: string

Valeur de propriété

string

Hérité deParticipantInfo.displayName

endpointDetails

Obtenir les détails de tous les points de terminaison pour ce participant distant

endpointDetails: EndpointDetails[]

Valeur de propriété

EndpointDetails[]

Hérité deParticipantInfo.endpointDetails

identifier

Obtenez l’identificateur de ce participant distant.

identifier: CommunicationIdentifierKind

Valeur de propriété

CommunicationIdentifierKind

Hérité deParticipantInfo.identifier

Détails de la méthode

mute()

Notes

Ce API est en version bêta et est fourni en tant qu’aperçu pour les développeurs et il peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Désactiver le micro de ce participant distant.

function mute(): Promise<void>

Retours

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement displayNameChanged.

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

Paramètres

event

"displayNameChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("isMutedChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isMutedChanged.

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

Paramètres

event

"isMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("isSpeakingChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement isSpeakingChanged.

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

Paramètres

event

"isSpeakingChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("roleChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement roleChanged.

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

Paramètres

event

"roleChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("stateChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement stateChanged.

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

Paramètres

event

"stateChanged"

nom de l’événement.

listener
PropertyChangedEvent

rappel fn utilisé pour s’abonner à cet événement.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Fonction de désabonnement pour l’événement videoStreamsUpdated.

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

Paramètres

event

"videoStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteVideoStream>

rappel fn utilisé pour s’abonner à cet événement.

on("displayNameChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement displayNameChanged.

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

Paramètres

event

"displayNameChanged"

nom de l’événement.

listener
PropertyChangedEvent

callback fn qui sera appelé lorsque la valeur de cette propriété change.

on("isMutedChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement isMutedChanged.

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

Paramètres

event

"isMutedChanged"

nom de l’événement.

listener
PropertyChangedEvent

callback fn qui sera appelé lorsque la valeur de cette propriété change.

on("isSpeakingChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement isSpeakingChanged.

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

Paramètres

event

"isSpeakingChanged"

nom de l’événement.

listener
PropertyChangedEvent

callback fn qui sera appelé lorsque la valeur de cette propriété change.

on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement roleChanged.

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

Paramètres

event

"roleChanged"

nom de l’événement.

listener
PropertyChangedEvent

callback fn qui sera appelé lorsque la valeur de cette propriété change.

on("stateChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement stateChanged.

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

Paramètres

event

"stateChanged"

nom de l’événement.

listener
PropertyChangedEvent

callback fn qui sera appelé lorsque la valeur de cette propriété change.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Fonction d’abonnement pour l’événement videoStreamsUpdated.

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

Paramètres

event

"videoStreamsUpdated"

nom de l’événement.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn qui sera appelé lorsque cette collection changera, il passera des tableaux d’éléments ajoutés et supprimés.