Freigeben über

RemoteParticipant interface

  • Referenz
Paket:
@azure/communication-calling

Stellt einen Remoteteilnehmer an einem Anruf dar.

Extends
ParticipantInfo

Eigenschaften

callEndReason

Grund, warum der Teilnehmer den Anruf verlassen hat, enthält Code/SubCode/Nachricht.
isMuted

Gibt an, ob dieser Remoteteilnehmer stummgeschaltet ist oder nicht.
isSpeaking

Ob dieser Remoteteilnehmer spricht oder nicht.
role

Rufen Sie die Rolle dieses Remoteteilnehmers ab.
state

Ruft den Zustand dieses Remoteteilnehmers ab.
videoStreams

Sammlung von Videostreams, über die die Teilnehmer verfügen.

Geerbte Eigenschaften

displayName

Optionaler Anzeigename, wenn er vom Endpunkt dieses Remoteteilnehmers festgelegt wurde.
endpointDetails

Abrufen der Details aller Endpunkte für diesen Remoteteilnehmer
identifier

Ruft den Bezeichner dieses Remoteteilnehmers ab.

Methoden

mute()

Stummschalten des Mikrofons dieses Remoteteilnehmers.
off("displayNameChanged", PropertyChangedEvent)

Unsubscribe-Funktion für displayNameChanged-Ereignis.
off("isMutedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isMutedChanged-Ereignis.
off("isSpeakingChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isSpeakingChanged-Ereignis.
off("roleChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das roleChanged-Ereignis.
off("stateChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das stateChanged-Ereignis.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Unsubscribe-Funktion für videoStreamsUpdated-Ereignis.
on("displayNameChanged", PropertyChangedEvent)

Subscribe-Funktion für displayNameChanged-Ereignis.
on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.
on("isSpeakingChanged", PropertyChangedEvent)

Subscribe-Funktion für das isSpeakingChanged-Ereignis.
on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das roleChanged-Ereignis.
on("stateChanged", PropertyChangedEvent)

Subscribe-Funktion für das stateChanged-Ereignis.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Subscribe-Funktion für videoStreamsUpdated-Ereignis.

Details zur Eigenschaft

callEndReason

Grund, warum der Teilnehmer den Anruf verlassen hat, enthält Code/SubCode/Nachricht.

callEndReason?: CallEndReason

Eigenschaftswert

CallEndReason

isMuted

Gibt an, ob dieser Remoteteilnehmer stummgeschaltet ist oder nicht.

isMuted: boolean

Eigenschaftswert

boolean

isSpeaking

Ob dieser Remoteteilnehmer spricht oder nicht.

isSpeaking: boolean

Eigenschaftswert

boolean

role

Rufen Sie die Rolle dieses Remoteteilnehmers ab.

role: ParticipantRole

Eigenschaftswert

ParticipantRole

state

Ruft den Zustand dieses Remoteteilnehmers ab.

state: RemoteParticipantState

Eigenschaftswert

RemoteParticipantState

videoStreams

Sammlung von Videostreams, über die die Teilnehmer verfügen.

videoStreams: ReadonlyArray<RemoteVideoStream>

Eigenschaftswert

ReadonlyArray<RemoteVideoStream>

Geerbte Eigenschaftsdetails

displayName

Optionaler Anzeigename, wenn er vom Endpunkt dieses Remoteteilnehmers festgelegt wurde.

displayName?: string

Eigenschaftswert

string

Geerbt vonParticipantInfo.displayName

endpointDetails

Abrufen der Details aller Endpunkte für diesen Remoteteilnehmer

endpointDetails: EndpointDetails[]

Eigenschaftswert

EndpointDetails[]

Geerbt vonParticipantInfo.endpointDetails

identifier

Ruft den Bezeichner dieses Remoteteilnehmers ab.

identifier: CommunicationIdentifierKind

Eigenschaftswert

CommunicationIdentifierKind

Geerbt vonParticipantInfo.identifier

Details zur Methode

mute()

Hinweis

API befindet sich in der Betaphase und ist als Vorschauversion für Entwickler*innen verfügbar. Je nachdem, welches Feedback wir erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stummschalten des Mikrofons dieses Remoteteilnehmers.

function mute(): Promise<void>

Gibt zurück

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Unsubscribe-Funktion für displayNameChanged-Ereignis.

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

Parameter

event

"displayNameChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("isMutedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("isSpeakingChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das isSpeakingChanged-Ereignis.

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

Parameter

event

"isSpeakingChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("roleChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("stateChanged", PropertyChangedEvent)

Unsubscribe-Funktion für das stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Unsubscribe-Funktion für videoStreamsUpdated-Ereignis.

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

Parameter

event

"videoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteVideoStream>

Rückruf fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

on("displayNameChanged", PropertyChangedEvent)

Subscribe-Funktion für displayNameChanged-Ereignis.

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

Parameter

event

"displayNameChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für das isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("isSpeakingChanged", PropertyChangedEvent)

Subscribe-Funktion für das isSpeakingChanged-Ereignis.

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

Parameter

event

"isSpeakingChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("stateChanged", PropertyChangedEvent)

Subscribe-Funktion für das stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

Rückruf fn, der aufgerufen wird, wenn sich der Wert dieser Eigenschaft ändert.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Subscribe-Funktion für videoStreamsUpdated-Ereignis.

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

Parameter

event

"videoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn, der aufgerufen wird, wenn sich diese Auflistung ändert, übergeben Arrays von hinzugefügten und entfernten Elementen.