RemoteParticipant interface

Representerar en fjärrdeltagare i ett anrop.

Extends

Egenskaper

callEndReason

Orsak till att deltagaren lämnade anropet, innehåller kod/underkod/meddelande.

isMuted

Om den här fjärrdeltagaren är avstängd eller inte.

isSpeaking

Oavsett om den här fjärrdeltagaren talar eller inte.

role

Hämta rollen som den här fjärrdeltagaren.

state

Hämta tillstånd för den här fjärrdeltagaren.

videoStreams

Insamling av videoströmmar som deltagarna har.

Ärvda egenskaper

displayName

Valfritt visningsnamn, om det har angetts av slutpunkten för den fjärrdeltagaren.

endpointDetails

Hämta information om alla slutpunkter för den här fjärrdeltagaren

identifier

Hämta identifieraren för den här fjärrdeltagaren.

Metoder

mute()

Stäng av mikrofonen för den här fjärrdeltagaren.

off("displayNameChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för displayNameChanged-händelsen.

off("isMutedChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isMutedChanged-händelsen.

off("isSpeakingChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isSpeakingChanged-händelsen.

off("roleChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för roleChanged-händelsen.

off("stateChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för stateChanged-händelsen.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Avsluta prenumerationsfunktionen för videoStreamsUpdated-händelsen.

on("displayNameChanged", PropertyChangedEvent)

Prenumerationsfunktion för displayNameChanged-händelse.

on("isMutedChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isMutedChanged-händelsen.

on("isSpeakingChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isSpeakingChanged-händelsen.

on("roleChanged", PropertyChangedEvent)

Prenumerationsfunktion för roleChanged-händelse.

on("stateChanged", PropertyChangedEvent)

Prenumerationsfunktion för stateChanged-händelse.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Prenumerationsfunktion för videoStreamsUpdated-händelse.

Egenskapsinformation

callEndReason

Orsak till att deltagaren lämnade anropet, innehåller kod/underkod/meddelande.

callEndReason?: CallEndReason

Egenskapsvärde

isMuted

Om den här fjärrdeltagaren är avstängd eller inte.

isMuted: boolean

Egenskapsvärde

boolean

isSpeaking

Oavsett om den här fjärrdeltagaren talar eller inte.

isSpeaking: boolean

Egenskapsvärde

boolean

role

Hämta rollen som den här fjärrdeltagaren.

role: ParticipantRole

Egenskapsvärde

state

Hämta tillstånd för den här fjärrdeltagaren.

state: RemoteParticipantState

Egenskapsvärde

videoStreams

Insamling av videoströmmar som deltagarna har.

videoStreams: readonly RemoteVideoStream[]

Egenskapsvärde

readonly RemoteVideoStream[]

Information om ärvda egenskaper

displayName

Valfritt visningsnamn, om det har angetts av slutpunkten för den fjärrdeltagaren.

displayName?: string

Egenskapsvärde

string

ärvd frånParticipantInfo.displayName

endpointDetails

Hämta information om alla slutpunkter för den här fjärrdeltagaren

endpointDetails: EndpointDetails[]

Egenskapsvärde

ärvs frånParticipantInfo.endpointDetails

identifier

Hämta identifieraren för den här fjärrdeltagaren.

identifier: CommunicationIdentifierKind

Egenskapsvärde

ärvd frånParticipantInfo.identifier

Metodinformation

mute()

Stäng av mikrofonen för den här fjärrdeltagaren.

function mute(): Promise<void>

Returer

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för displayNameChanged-händelsen.

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

Parametrar

event

"displayNameChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

off("isMutedChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isMutedChanged-händelsen.

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

Parametrar

event

"isMutedChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

off("isSpeakingChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isSpeakingChanged-händelsen.

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

Parametrar

event

"isSpeakingChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

off("roleChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för roleChanged-händelsen.

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

Parametrar

event

"roleChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

off("stateChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för stateChanged-händelsen.

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

Parametrar

event

"stateChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Avsluta prenumerationsfunktionen för videoStreamsUpdated-händelsen.

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

Parametrar

event

"videoStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn som användes för att prenumerera på den här händelsen.

on("displayNameChanged", PropertyChangedEvent)

Prenumerationsfunktion för displayNameChanged-händelse.

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

Parametrar

event

"displayNameChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("isMutedChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isMutedChanged-händelsen.

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

Parametrar

event

"isMutedChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("isSpeakingChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isSpeakingChanged-händelsen.

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

Parametrar

event

"isSpeakingChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("roleChanged", PropertyChangedEvent)

Prenumerationsfunktion för roleChanged-händelse.

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

Parametrar

event

"roleChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("stateChanged", PropertyChangedEvent)

Prenumerationsfunktion för stateChanged-händelse.

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

Parametrar

event

"stateChanged"

händelsenamn.

listener
PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Prenumerationsfunktion för videoStreamsUpdated-händelse.

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

Parametrar

event

"videoStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteVideoStream>

återanrop fn som kommer att anropas när den här samlingen ändras, kommer den att skicka matriser med tillagda och borttagna element.