RemoteParticipant interface

Pakket:

@azure/communication-calling

Vertegenwoordigt een externe deelnemer in een gesprek.

Uitbreiding

ParticipantInfo

Eigenschappen

callEndReason	Reden waarom de deelnemer de oproep heeft verlaten, bevat code/subCode/message.
isMuted	Of deze externe deelnemer is gedempt of niet.
isSpeaking	Of deze externe deelnemer nu spreekt of niet.
role	De rol van deze externe deelnemer ophalen.
state	Status van deze externe deelnemer ophalen.
videoStreams	Verzameling videostreams die deze deelnemers hebben.

Overgenomen eigenschappen

displayName	Optionele weergavenaam, als deze is ingesteld door het eindpunt van die externe deelnemer.
endpointDetails	De details van alle eindpunten voor deze externe deelnemer ophalen
identifier	Haal de id voor deze externe deelnemer op.

Methoden

mute()	Demp de microfoon van deze externe deelnemer.
off("displayNameChanged", PropertyChangedEvent)	Afmeldingsfunctie voor displayNameChanged-gebeurtenis.
off("isMutedChanged", PropertyChangedEvent)	De functie Afmelden voor isMutedChanged-gebeurtenis.
off("isSpeakingChanged", PropertyChangedEvent)	Afmeldingsfunctie voor isSpeakingChanged-gebeurtenis.
off("roleChanged", PropertyChangedEvent)	De functie Afmelden voor de roleChanged-gebeurtenis.
off("stateChanged", PropertyChangedEvent)	Afmeldingsfunctie voor stateChanged-gebeurtenis.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	De functie Afmelden voor de gebeurtenis videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)	Abonneer de functie voor displayNameChanged-gebeurtenis.
on("isMutedChanged", PropertyChangedEvent)	De functie Abonneren voor de gebeurtenis isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)	De functie Abonneren voor isSpeakingChanged-gebeurtenis.
on("roleChanged", PropertyChangedEvent)	Abonneer de functie voor roleChanged-gebeurtenis.
on("stateChanged", PropertyChangedEvent)	Abonneer de functie voor stateChanged-gebeurtenis.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	Abonneer de functie voor de gebeurtenis videoStreamsUpdated.

Eigenschapdetails

callEndReason

Reden waarom de deelnemer de oproep heeft verlaten, bevat code/subCode/message.

callEndReason?: CallEndReason

Waarde van eigenschap

CallEndReason

isMuted

Of deze externe deelnemer is gedempt of niet.

isMuted: boolean

Waarde van eigenschap

boolean

isSpeaking

Of deze externe deelnemer nu spreekt of niet.

isSpeaking: boolean

Waarde van eigenschap

boolean

role

De rol van deze externe deelnemer ophalen.

role: ParticipantRole

Waarde van eigenschap

ParticipantRole

state

Status van deze externe deelnemer ophalen.

state: RemoteParticipantState

Waarde van eigenschap

RemoteParticipantState

videoStreams

Verzameling videostreams die deze deelnemers hebben.

videoStreams: readonly RemoteVideoStream[]

Waarde van eigenschap

readonly RemoteVideoStream[]

Details van overgenomen eigenschap

displayName

Optionele weergavenaam, als deze is ingesteld door het eindpunt van die externe deelnemer.

displayName?: string

Waarde van eigenschap

string

overgenomen vanParticipantInfo.displayName

endpointDetails

De details van alle eindpunten voor deze externe deelnemer ophalen

endpointDetails: EndpointDetails[]

Waarde van eigenschap

EndpointDetails[]

overgenomen vanParticipantInfo.endpointDetails

identifier

Haal de id voor deze externe deelnemer op.

identifier: CommunicationIdentifierKind

Waarde van eigenschap

CommunicationIdentifierKind

overgenomen vanParticipantInfo.identifier

Methodedetails

mute()

Demp de microfoon van deze externe deelnemer.

function mute(): Promise<void>

Retouren

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Afmeldingsfunctie voor displayNameChanged-gebeurtenis.

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

Parameters

event

"displayNameChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("isMutedChanged", PropertyChangedEvent)

De functie Afmelden voor isMutedChanged-gebeurtenis.

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

Parameters

event

"isMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("isSpeakingChanged", PropertyChangedEvent)

Afmeldingsfunctie voor isSpeakingChanged-gebeurtenis.

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

Parameters

event

"isSpeakingChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("roleChanged", PropertyChangedEvent)

De functie Afmelden voor de roleChanged-gebeurtenis.

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

Parameters

event

"roleChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("stateChanged", PropertyChangedEvent)

Afmeldingsfunctie voor stateChanged-gebeurtenis.

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

Parameters

event

"stateChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

De functie Afmelden voor de gebeurtenis videoStreamsUpdated.

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

Parameters

event

"videoStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn die is gebruikt om u te abonneren op deze gebeurtenis.

on("displayNameChanged", PropertyChangedEvent)

Abonneer de functie voor displayNameChanged-gebeurtenis.

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

Parameters

event

"displayNameChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isMutedChanged", PropertyChangedEvent)

De functie Abonneren voor de gebeurtenis isMutedChanged.

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

Parameters

event

"isMutedChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("isSpeakingChanged", PropertyChangedEvent)

De functie Abonneren voor isSpeakingChanged-gebeurtenis.

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

Parameters

event

"isSpeakingChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("roleChanged", PropertyChangedEvent)

Abonneer de functie voor roleChanged-gebeurtenis.

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

Parameters

event

"roleChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("stateChanged", PropertyChangedEvent)

Abonneer de functie voor stateChanged-gebeurtenis.

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

Parameters

event

"stateChanged"

gebeurtenisnaam.

listener

PropertyChangedEvent

callback fn die wordt aangeroepen wanneer de waarde van deze eigenschap wordt gewijzigd.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Abonneer de functie voor de gebeurtenis videoStreamsUpdated.

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

Parameters

event

"videoStreamsUpdated"

gebeurtenisnaam.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn die wordt aangeroepen wanneer deze verzameling wordt gewijzigd, geeft deze matrices van toegevoegde en verwijderde elementen door.