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, dílčí kód nebo zprávu.
isMuted

Jestli je tento vzdálený účastník ztlumený nebo ne.
isSpeaking

Jestli tento vzdálený účastník mluví, nebo ne.
role

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

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

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

Zděděné vlastnosti

displayName

Volitelný zobrazovaný název, pokud ho nastavil koncový bod tohoto vzdáleného účastníka.
endpointDetails

Získání podrobností 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()

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

Funkce Unsubscribe pro událost displayNameChanged
off("isMutedChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost isSpeakingChanged
off("roleChanged", PropertyChangedEvent)

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

Funkce Unsubscribe pro událost stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

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

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

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

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

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

Funkce Subscribe pro událost stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce Subscribe pro událost videoStreamsUpdated

Podrobnosti vlastnosti

callEndReason

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

callEndReason?: CallEndReason

Hodnota vlastnosti

CallEndReason

isMuted

Jestli je tento vzdálený účastník ztlumený nebo ne.

isMuted: boolean

Hodnota vlastnosti

boolean

isSpeaking

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íská stav tohoto vzdáleného účastníka.

state: RemoteParticipantState

Hodnota vlastnosti

RemoteParticipantState

videoStreams

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

videoStreams: ReadonlyArray<RemoteVideoStream>

Hodnota vlastnosti

ReadonlyArray<RemoteVideoStream>

Podrobnosti zděděných vlastností

displayName

Volitelný zobrazovaný název, pokud ho nastavil koncový bod tohoto vzdáleného účastníka.

displayName?: string

Hodnota vlastnosti

string

Zděděno zParticipantInfo.displayName

endpointDetails

Získání podrobností o všech koncových bodech pro tohoto vzdáleného účastníka

endpointDetails: EndpointDetails[]

Hodnota vlastnosti

EndpointDetails[]

Zděděno zParticipantInfo.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()

Poznámka

Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.

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

function mute(): Promise<void>

Návraty

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost displayNameChanged

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

Parametry

event

"displayNameChanged"

název události.

listener
PropertyChangedEvent

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

off("isMutedChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost isMutedChanged.

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

Parametry

event

"isMutedChanged"

název události.

listener
PropertyChangedEvent

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

off("isSpeakingChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost isSpeakingChanged

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

Parametry

event

"isSpeakingChanged"

název události.

listener
PropertyChangedEvent

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

off("roleChanged", PropertyChangedEvent)

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

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

Parametry

event

"roleChanged"

název události.

listener
PropertyChangedEvent

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

off("stateChanged", PropertyChangedEvent)

Funkce Unsubscribe pro událost stateChanged.

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

Parametry

event

"stateChanged"

název události.

listener
PropertyChangedEvent

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

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funkce pro odhlášení odběru události videoStreamsUpdated

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

Parametry

event

"videoStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<RemoteVideoStream>

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

on("displayNameChanged", PropertyChangedEvent)

Funkce Subscribe pro událost displayNameChanged

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

Parametry

event

"displayNameChanged"

název události.

listener
PropertyChangedEvent

callback fn, která bude volána 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ána 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ána při změně hodnoty této vlastnosti.

on("roleChanged", PropertyChangedEvent)

Funkce Subscribe pro událost roleChanged.

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

Parametry

event

"roleChanged"

název události.

listener
PropertyChangedEvent

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

on("stateChanged", PropertyChangedEvent)

Funkce Subscribe pro událost stateChanged.

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

Parametry

event

"stateChanged"

název události.

listener
PropertyChangedEvent

callback fn, která bude volána 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>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.