RemoteParticipant interface
Representerar en fjärrdeltagare i ett anrop.
- Extends
Egenskaper
call |
Orsak till varför deltagaren lämnade anropet, innehåller kod/underkod/meddelande. |
is |
Om den här fjärrdeltagaren är avstängd eller inte. |
is |
Oavsett om den här fjärrdeltagaren talar eller inte. |
role | Hämta rollen för den här fjärrdeltagaren. |
state | Hämta tillstånd för den här fjärrdeltagaren. |
video |
Insamling av videoströmmar som deltagarna har. |
Ärvda egenskaper
display |
Valfritt visningsnamn, om det angavs av slutpunkten för den fjärrdeltagaren. |
endpoint |
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("display |
Avsluta prenumerationsfunktionen för displayNameChanged-händelsen. |
off("is |
Funktionen Avbryt prenumeration för isMutedChanged-händelsen. |
off("is |
Funktionen Avbryt prenumeration för isSpeakingChanged-händelsen. |
off("role |
Avsluta prenumerationsfunktionen för roleChanged-händelsen. |
off("state |
Avsluta prenumerationsfunktionen för stateChanged-händelsen. |
off("video |
Avsluta prenumerationsfunktionen för videoStreamsUpdated-händelsen. |
on("display |
Funktionen Prenumerera för displayNameChanged-händelsen. |
on("is |
Funktionen Prenumerera på händelsen isMutedChanged. |
on("is |
Funktionen Prenumerera på isSpeakingChanged-händelsen. |
on("role |
Prenumerationsfunktion för roleChanged-händelse. |
on("state |
Prenumerationsfunktion för stateChanged-händelse. |
on("video |
Funktionen Prenumerera på videoStreamsUpdated-händelsen. |
Egenskapsinformation
callEndReason
Orsak till varför 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
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: ReadonlyArray<RemoteVideoStream>
Egenskapsvärde
ReadonlyArray<RemoteVideoStream>
Information om ärvda egenskaper
displayName
Valfritt visningsnamn, om det angavs 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
Ärvd frånParticipantInfo.endpointDetails
identifier
Hämta identifieraren för den här fjärrdeltagaren.
identifier: CommunicationIdentifierKind
Egenskapsvärde
CommunicationIdentifierKind
Ärvd frånParticipantInfo.identifier
Metodinformation
mute()
Anteckning
Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.
Stäng av mikrofonen för den här fjärrdeltagaren.
function mute(): Promise<void>
Returer
Promise<void>
off("displayNameChanged", PropertyChangedEvent)
Avsluta prenumerationsfunktionen 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
callback fn som användes för att prenumerera på den här händelsen.
on("displayNameChanged", PropertyChangedEvent)
Funktionen Prenumerera för displayNameChanged-händelsen.
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)
Funktionen Prenumerera på händelsen isMutedChanged.
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)
Funktionen Prenumerera på 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>)
Funktionen Prenumerera på videoStreamsUpdated-händelsen.
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)
Parametrar
- event
-
"videoStreamsUpdated"
händelsenamn.
- listener
callback fn som kommer att anropas när den här samlingen ändras skickas matriser med tillagda och borttagna element.