RemoteParticipant interface
Reprezentuje uczestnika zdalnego w wywołaniu.
- Rozszerzenie
Właściwości
| call |
Przyczyna, dla którego uczestnik opuścił wywołanie, zawiera kod/podkod/komunikat. |
| is |
Niezależnie od tego, czy ten uczestnik zdalny jest wyciszony, czy nie. |
| is |
Niezależnie od tego, czy ten zdalny uczestnik mówi, czy nie. |
| role | Uzyskaj rolę tego uczestnika zdalnego. |
| state | Uzyskaj stan tego uczestnika zdalnego. |
| video |
Kolekcja strumieni wideo, które mają uczestnicy. |
Właściwości dziedziczone
| display |
Opcjonalna nazwa wyświetlana, jeśli została ustawiona przez punkt końcowy tego uczestnika zdalnego. |
| endpoint |
Pobierz szczegóły wszystkich punktów końcowych dla tego uczestnika zdalnego |
| identifier | Pobierz identyfikator tego uczestnika zdalnego. |
Metody
| mute() | Wycisz mikrofon tego uczestnika zdalnego. |
| off("display |
Anuluj subskrypcję funkcji dla zdarzenia displayNameChanged. |
| off("is |
Funkcja anuluj subskrypcję zdarzenia isMutedChanged. |
| off("is |
Funkcja anuluj subskrypcję zdarzenia isSpeakingChanged. |
| off("role |
Anuluj subskrypcję funkcji dla zdarzenia roleChanged. |
| off("state |
Funkcja anulowania subskrypcji dla zdarzenia stateChanged. |
| off("video |
Funkcja anuluj subskrypcję zdarzenia videoStreamsUpdated. |
| on("display |
Subskrybuj funkcję dla zdarzenia displayNameChanged. |
| on("is |
Funkcja subskrybuj dla zdarzenia isMutedChanged. |
| on("is |
Funkcja subskrybuj dla zdarzenia isSpeakingChanged. |
| on("role |
Subskrybuj funkcję dla zdarzenia roleChanged. |
| on("state |
Subskrybuj funkcję dla zdarzenia stateChanged. |
| on("video |
Funkcja subskrybuj zdarzenie videoStreamsUpdated. |
Szczegóły właściwości
callEndReason
Przyczyna, dla którego uczestnik opuścił wywołanie, zawiera kod/podkod/komunikat.
callEndReason?: CallEndReasonWartość właściwości
isMuted
Niezależnie od tego, czy ten uczestnik zdalny jest wyciszony, czy nie.
isMuted: booleanWartość właściwości
boolean
isSpeaking
Niezależnie od tego, czy ten zdalny uczestnik mówi, czy nie.
isSpeaking: booleanWartość właściwości
boolean
role
state
Uzyskaj stan tego uczestnika zdalnego.
state: RemoteParticipantStateWartość właściwości
videoStreams
Kolekcja strumieni wideo, które mają uczestnicy.
videoStreams: readonly RemoteVideoStream[]Wartość właściwości
readonly RemoteVideoStream[]
Szczegóły właściwości dziedziczonej
displayName
Opcjonalna nazwa wyświetlana, jeśli została ustawiona przez punkt końcowy tego uczestnika zdalnego.
displayName?: stringWartość właściwości
string
dziedziczone zParticipantInfo.displayName
endpointDetails
Pobierz szczegóły wszystkich punktów końcowych dla tego uczestnika zdalnego
endpointDetails: EndpointDetails[]Wartość właściwości
dziedziczone zParticipantInfo.endpointDetails
identifier
Pobierz identyfikator tego uczestnika zdalnego.
identifier: CommunicationIdentifierKindWartość właściwości
dziedziczone zParticipantInfo.identifier
Szczegóły metody
mute()
Wycisz mikrofon tego uczestnika zdalnego.
function mute(): Promise<void>Zwraca
Promise<void>
off("displayNameChanged", PropertyChangedEvent)
Anuluj subskrypcję funkcji dla zdarzenia displayNameChanged.
function off(event: "displayNameChanged", listener: PropertyChangedEvent)Parametry
- event
-
"displayNameChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
off("isMutedChanged", PropertyChangedEvent)
Funkcja anuluj subskrypcję zdarzenia isMutedChanged.
function off(event: "isMutedChanged", listener: PropertyChangedEvent)Parametry
- event
-
"isMutedChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
off("isSpeakingChanged", PropertyChangedEvent)
Funkcja anuluj subskrypcję zdarzenia isSpeakingChanged.
function off(event: "isSpeakingChanged", listener: PropertyChangedEvent)Parametry
- event
-
"isSpeakingChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
off("roleChanged", PropertyChangedEvent)
Anuluj subskrypcję funkcji dla zdarzenia roleChanged.
function off(event: "roleChanged", listener: PropertyChangedEvent)Parametry
- event
-
"roleChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
off("stateChanged", PropertyChangedEvent)
Funkcja anulowania subskrypcji dla zdarzenia stateChanged.
function off(event: "stateChanged", listener: PropertyChangedEvent)Parametry
- event
-
"stateChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Funkcja anuluj subskrypcję zdarzenia videoStreamsUpdated.
function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Parametry
- event
-
"videoStreamsUpdated"
nazwa zdarzenia.
- listener
fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.
on("displayNameChanged", PropertyChangedEvent)
Subskrybuj funkcję dla zdarzenia displayNameChanged.
function on(event: "displayNameChanged", listener: PropertyChangedEvent)Parametry
- event
-
"displayNameChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.
on("isMutedChanged", PropertyChangedEvent)
Funkcja subskrybuj dla zdarzenia isMutedChanged.
function on(event: "isMutedChanged", listener: PropertyChangedEvent)Parametry
- event
-
"isMutedChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.
on("isSpeakingChanged", PropertyChangedEvent)
Funkcja subskrybuj dla zdarzenia isSpeakingChanged.
function on(event: "isSpeakingChanged", listener: PropertyChangedEvent)Parametry
- event
-
"isSpeakingChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.
on("roleChanged", PropertyChangedEvent)
Subskrybuj funkcję dla zdarzenia roleChanged.
function on(event: "roleChanged", listener: PropertyChangedEvent)Parametry
- event
-
"roleChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.
on("stateChanged", PropertyChangedEvent)
Subskrybuj funkcję dla zdarzenia stateChanged.
function on(event: "stateChanged", listener: PropertyChangedEvent)Parametry
- event
-
"stateChanged"
nazwa zdarzenia.
- listener
- PropertyChangedEvent
wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)
Funkcja subskrybuj zdarzenie videoStreamsUpdated.
function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)Parametry
- event
-
"videoStreamsUpdated"
nazwa zdarzenia.
- listener
wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.