RemoteParticipant interface
Rappresenta un partecipante remoto in una chiamata.
- Extends
Proprietà
| call |
Motivo per cui il partecipante ha lasciato la chiamata, contiene codice/subCode/message. |
| is |
Indica se il partecipante remoto è disattivato o meno. |
| is |
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. |
| video |
Raccolta di flussi video di questo partecipante. |
Proprietà ereditate
| display |
Nome visualizzato facoltativo, se è stato impostato dall'endpoint del partecipante remoto. |
| endpoint |
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("display |
Annulla la sottoscrizione della funzione per l'evento displayNameChanged. |
| off("is |
Funzione Unsubscribe per l'evento isMutedChanged. |
| off("is |
Funzione Unsubscribe per l'evento isSpeakingChanged. |
| off("role |
Annulla la sottoscrizione della funzione per l'evento roleChanged. |
| off("state |
Annulla la sottoscrizione della funzione per l'evento stateChanged. |
| off("video |
Annulla la sottoscrizione della funzione per l'evento videoStreamsUpdated. |
| on("display |
Funzione Subscribe per l'evento displayNameChanged. |
| on("is |
Funzione Subscribe per l'evento isMutedChanged. |
| on("is |
Funzione Subscribe per l'evento isSpeakingChanged. |
| on("role |
Sottoscrivi la funzione per l'evento roleChanged. |
| on("state |
Funzione Subscribe per l'evento stateChanged. |
| on("video |
Funzione Subscribe per l'evento videoStreamsUpdated. |
Dettagli proprietà
callEndReason
Motivo per cui il partecipante ha lasciato la chiamata, contiene codice/subCode/message.
callEndReason?: CallEndReasonValore della proprietà
isMuted
Indica se il partecipante remoto è disattivato o meno.
isMuted: booleanValore della proprietà
boolean
isSpeaking
Indica se questo partecipante remoto sta parlando o meno.
isSpeaking: booleanValore della proprietà
boolean
role
Ottenere il ruolo di questo partecipante remoto.
role: ParticipantRoleValore della proprietà
state
Ottenere lo stato di questo partecipante remoto.
state: RemoteParticipantStateValore 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?: stringValore 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: CommunicationIdentifierKindValore 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
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
callback fn che verrà chiamato quando questa raccolta cambierà, passerà matrici di elementi aggiunti e rimossi.