Sdílet prostřednictvím

RemoteParticipant interface

  • Reference
Balíček:
@azure/communication-calling

Představuje vzdáleného účastníka hovoru.

Extends
ParticipantInfo

Vlastnosti

callEndReason

Důvod, proč účastník opustil hovor, obsahuje kód, podkódu nebo zprávu.
isMuted

Ať už je tento vzdálený účastník ztlumený, nebo ne.
isSpeaking

Bez ohledu na to, jestli tento vzdálený účastník mluví nebo ne.
role

Získejte roli tohoto vzdáleného účastníka.
state

Získejte stav tohoto vzdáleného účastníka.
videoStreams

Kolekce video streamů, které účastníci mají.

Zděděné vlastnosti

displayName

Nepovinný zobrazovaný název, pokud byl nastaven koncovým bodem tohoto vzdáleného účastníka.
endpointDetails

Získejte podrobnosti o všech koncových bodech pro tohoto vzdáleného účastníka.
identifier

Získejte identifikátor tohoto vzdáleného účastníka.

Metody

mute()

Ztlumit mikrofon tohoto vzdáleného účastníka.
off("displayNameChanged", PropertyChangedEvent)

Funkce odhlášení odběru události displayNameChanged
off("isMutedChanged", PropertyChangedEvent)

Funkce odhlášení odběru události isMutedChanged
off("isSpeakingChanged", PropertyChangedEvent)

Funkce odhlášení odběru události isSpeakingChanged
off("roleChanged", PropertyChangedEvent)

Funkce odhlášení odběru pro událost roleChanged
off("stateChanged", PropertyChangedEvent)

Funkce odhlášení odběru pro událost stateChanged
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce Odhlášení odběru události videoStreamsUpdated
on("displayNameChanged", PropertyChangedEvent)

Funkce Přihlásit se k odběru události displayNameChanged
on("isMutedChanged", PropertyChangedEvent)

Funkce Subscribe pro událost isMutedChanged
on("isSpeakingChanged", PropertyChangedEvent)

Funkce Subscribe pro událost isSpeakingChanged
on("roleChanged", PropertyChangedEvent)

Přihlásit se k odběru funkce pro událost roleChanged
on("stateChanged", PropertyChangedEvent)

Funkce Přihlásit se k odběru události stateChanged
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce Subscribe pro událost videoStreamsUpdated

Podrobnosti vlastnosti

callEndReason

Důvod, proč účastník opustil hovor, obsahuje kód, podkódu nebo zprávu.

callEndReason?: CallEndReason

Hodnota vlastnosti

CallEndReason

isMuted

Ať už je tento vzdálený účastník ztlumený, nebo ne.

isMuted: boolean

Hodnota vlastnosti

boolean

isSpeaking

Bez ohledu na to, jestli tento vzdálený účastník mluví nebo ne.

isSpeaking: boolean

Hodnota vlastnosti

boolean

role

Získejte roli tohoto vzdáleného účastníka.

role: ParticipantRole

Hodnota vlastnosti

ParticipantRole

state

Získejte stav tohoto vzdáleného účastníka.

state: RemoteParticipantState

Hodnota vlastnosti

RemoteParticipantState

videoStreams

Kolekce video streamů, které účastníci mají.

videoStreams: readonly RemoteVideoStream[]

Hodnota vlastnosti

readonly RemoteVideoStream[]

Podrobnosti zděděných vlastností

displayName

Nepovinný zobrazovaný název, pokud byl nastaven koncovým bodem tohoto vzdáleného účastníka.

displayName?: string

Hodnota vlastnosti

string

zděděno zParticipantInfo.displayName

endpointDetails

Získejte podrobnosti o všech koncových bodech pro tohoto vzdáleného účastníka.

endpointDetails: EndpointDetails[]

Hodnota vlastnosti

EndpointDetails[]

zděděno ze souboruParticipantInfo.endpointDetails

identifier

Získejte identifikátor tohoto vzdáleného účastníka.

identifier: CommunicationIdentifierKind

Hodnota vlastnosti

CommunicationIdentifierKind

zděděno zParticipantInfo.identifier

Podrobnosti metody

mute()

Ztlumit mikrofon tohoto vzdáleného účastníka.

function mute(): Promise<void>

Návraty

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Funkce odhlášení odběru události displayNameChanged

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

Parametry

event

"displayNameChanged"

název události.

listener
PropertyChangedEvent

callback fn, který byl použit k přihlášení k odběru této události.

off("isMutedChanged", PropertyChangedEvent)

Funkce odhlášení odběru události isMutedChanged

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

Parametry

event

"isMutedChanged"

název události.

listener
PropertyChangedEvent

callback fn, který byl použit k přihlášení k odběru této události.

off("isSpeakingChanged", PropertyChangedEvent)

Funkce odhlášení odběru události isSpeakingChanged

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

Parametry

event

"isSpeakingChanged"

název události.

listener
PropertyChangedEvent

callback fn, který byl použit k přihlášení k odběru této události.

off("roleChanged", PropertyChangedEvent)

Funkce odhlášení odběru pro událost roleChanged

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

Parametry

event

"roleChanged"

název události.

listener
PropertyChangedEvent

callback fn, který byl použit k přihlášení k odběru této události.

off("stateChanged", PropertyChangedEvent)

Funkce odhlášení odběru pro událost stateChanged

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

Parametry

event

"stateChanged"

název události.

listener
PropertyChangedEvent

callback fn, který byl použit k přihlášení k odběru této události.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce Odhlášení odběru události videoStreamsUpdated

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

Parametry

event

"videoStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn, který byl použit k přihlášení k odběru této události.

on("displayNameChanged", PropertyChangedEvent)

Funkce Přihlásit se k odběru události displayNameChanged

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

Parametry

event

"displayNameChanged"

název události.

listener
PropertyChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("isMutedChanged", PropertyChangedEvent)

Funkce Subscribe pro událost isMutedChanged

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

Parametry

event

"isMutedChanged"

název události.

listener
PropertyChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("isSpeakingChanged", PropertyChangedEvent)

Funkce Subscribe pro událost isSpeakingChanged

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

Parametry

event

"isSpeakingChanged"

název události.

listener
PropertyChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("roleChanged", PropertyChangedEvent)

Přihlásit se k odběru funkce pro událost roleChanged

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

Parametry

event

"roleChanged"

název události.

listener
PropertyChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("stateChanged", PropertyChangedEvent)

Funkce Přihlásit se k odběru události stateChanged

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

Parametry

event

"stateChanged"

název události.

listener
PropertyChangedEvent

callback fn, který bude volán při změně hodnoty této vlastnosti.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce Subscribe pro událost videoStreamsUpdated

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

Parametry

event

"videoStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.