Condividi tramite


RemoteParticipant interface

Rappresenta un partecipante remoto in una chiamata.

Extends

Proprietà

callEndReason

Motivo per cui il partecipante ha lasciato la chiamata, contiene codice/subCode/message.

isMuted

Indica se il partecipante remoto è disattivato o meno.

isSpeaking

Indica se questo partecipante remoto sta parlando o meno.

role

Ottenere il ruolo di questo partecipante remoto.

state

Ottenere lo stato di questo partecipante remoto.

videoStreams

Raccolta di flussi video di questo partecipante.

Proprietà ereditate

displayName

Nome visualizzato facoltativo, se è stato impostato dall'endpoint del partecipante remoto.

endpointDetails

Ottenere i dettagli di tutti gli endpoint per questo partecipante remoto

identifier

Ottenere l'identificatore per questo partecipante remoto.

Metodi

mute()

Disattivare il microfono di questo partecipante remoto.

off("displayNameChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento displayNameChanged.

off("isMutedChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isMutedChanged.

off("isSpeakingChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isSpeakingChanged.

off("roleChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento roleChanged.

off("stateChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento stateChanged.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Annulla la sottoscrizione della funzione per l'evento videoStreamsUpdated.

on("displayNameChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento displayNameChanged.

on("isMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isMutedChanged.

on("isSpeakingChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isSpeakingChanged.

on("roleChanged", PropertyChangedEvent)

Sottoscrivi la funzione per l'evento roleChanged.

on("stateChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento stateChanged.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funzione Subscribe per l'evento videoStreamsUpdated.

Dettagli proprietà

callEndReason

Motivo per cui il partecipante ha lasciato la chiamata, contiene codice/subCode/message.

callEndReason?: CallEndReason

Valore della proprietà

isMuted

Indica se il partecipante remoto è disattivato o meno.

isMuted: boolean

Valore della proprietà

boolean

isSpeaking

Indica se questo partecipante remoto sta parlando o meno.

isSpeaking: boolean

Valore della proprietà

boolean

role

Ottenere il ruolo di questo partecipante remoto.

role: ParticipantRole

Valore della proprietà

state

Ottenere lo stato di questo partecipante remoto.

state: RemoteParticipantState

Valore della proprietà

videoStreams

Raccolta di flussi video di questo partecipante.

videoStreams: readonly RemoteVideoStream[]

Valore della proprietà

readonly RemoteVideoStream[]

Dettagli proprietà ereditate

displayName

Nome visualizzato facoltativo, se è stato impostato dall'endpoint del partecipante remoto.

displayName?: string

Valore della proprietà

string

ereditato daParticipantInfo.displayName

endpointDetails

Ottenere i dettagli di tutti gli endpoint per questo partecipante remoto

endpointDetails: EndpointDetails[]

Valore della proprietà

ereditato daParticipantInfo.endpointDetails

identifier

Ottenere l'identificatore per questo partecipante remoto.

identifier: CommunicationIdentifierKind

Valore della proprietà

ereditato daParticipantInfo.identifier

Dettagli metodo

mute()

Disattivare il microfono di questo partecipante remoto.

function mute(): Promise<void>

Restituisce

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento displayNameChanged.

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

Parametri

event

"displayNameChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("isMutedChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isMutedChanged.

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

Parametri

event

"isMutedChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("isSpeakingChanged", PropertyChangedEvent)

Funzione Unsubscribe per l'evento isSpeakingChanged.

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

Parametri

event

"isSpeakingChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("roleChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento roleChanged.

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

Parametri

event

"roleChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("stateChanged", PropertyChangedEvent)

Annulla la sottoscrizione della funzione per l'evento stateChanged.

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

Parametri

event

"stateChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn usato per sottoscrivere questo evento.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Annulla la sottoscrizione della funzione per l'evento videoStreamsUpdated.

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

Parametri

event

"videoStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn usato per sottoscrivere questo evento.

on("displayNameChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento displayNameChanged.

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

Parametri

event

"displayNameChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isMutedChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isMutedChanged.

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

Parametri

event

"isMutedChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("isSpeakingChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento isSpeakingChanged.

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

Parametri

event

"isSpeakingChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("roleChanged", PropertyChangedEvent)

Sottoscrivi la funzione per l'evento roleChanged.

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

Parametri

event

"roleChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("stateChanged", PropertyChangedEvent)

Funzione Subscribe per l'evento stateChanged.

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

Parametri

event

"stateChanged"

nome dell'evento.

listener
PropertyChangedEvent

callback fn che verrà chiamato quando il valore di questa proprietà cambierà.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Funzione Subscribe per l'evento videoStreamsUpdated.

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

Parametri

event

"videoStreamsUpdated"

nome dell'evento.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.