Freigeben über

RemoteParticipant interface

  • Referenz
Paket:
@azure/communication-calling

Stellt einen Remoteteilnehmer in einem Anruf dar.

Extends
ParticipantInfo

Eigenschaften

callEndReason

Grund, warum Teilnehmer den Anruf verlassen haben, 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

Rufen Sie den Status dieses Remoteteilnehmers ab.
videoStreams

Sammlung von Videostreams, die diese Teilnehmer haben.

Geerbte Eigenschaften

displayName

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

Abrufen der Details aller Endpunkte für diesen Remoteteilnehmer
identifier

Rufen Sie den Bezeichner für diesen Remoteteilnehmer ab.

Methoden

mute()

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

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

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

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

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

Unsubscribe-Funktion für 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 isMutedChanged-Ereignis.
on("isSpeakingChanged", PropertyChangedEvent)

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

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

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

Subscribe-Funktion für das VideoStreamsUpdated-Ereignis.

Details zur Eigenschaft

callEndReason

Grund, warum Teilnehmer den Anruf verlassen haben, 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

Rufen Sie den Status dieses Remoteteilnehmers ab.

state: RemoteParticipantState

Eigenschaftswert

RemoteParticipantState

videoStreams

Sammlung von Videostreams, die diese Teilnehmer haben.

videoStreams: readonly RemoteVideoStream[]

Eigenschaftswert

readonly 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

Rufen Sie den Bezeichner für diesen Remoteteilnehmer ab.

identifier: CommunicationIdentifierKind

Eigenschaftswert

CommunicationIdentifierKind

vonParticipantInfo.identifier geerbt

Details zur Methode

mute()

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

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("isMutedChanged", PropertyChangedEvent)

Unsubscribe-Funktion für isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("isSpeakingChanged", PropertyChangedEvent)

Unsubscribe-Funktion für isSpeakingChanged-Ereignis.

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

Parameter

event

"isSpeakingChanged"

Ereignisname.

listener
PropertyChangedEvent

callback 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

callback fn, der zum Abonnieren dieses Ereignisses verwendet wurde.

off("stateChanged", PropertyChangedEvent)

Unsubscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

callback 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>

callback 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

callback fn that will be called when value of this property will change.

on("isMutedChanged", PropertyChangedEvent)

Subscribe-Funktion für isMutedChanged-Ereignis.

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

Parameter

event

"isMutedChanged"

Ereignisname.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isSpeakingChanged", PropertyChangedEvent)

Subscribe-Funktion für isSpeakingChanged-Ereignis.

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

Parameter

event

"isSpeakingChanged"

Ereignisname.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("roleChanged", PropertyChangedEvent)

Subscribe-Funktion für das roleChanged-Ereignis.

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

Parameter

event

"roleChanged"

Ereignisname.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("stateChanged", PropertyChangedEvent)

Subscribe-Funktion für stateChanged-Ereignis.

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

Parameter

event

"stateChanged"

Ereignisname.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Subscribe-Funktion für das VideoStreamsUpdated-Ereignis.

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

Parameter

event

"videoStreamsUpdated"

Ereignisname.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.