RemoteParticipant interface

Represents a remote participant in a call.

Extends

Properties

callEndReason

Reason why participant left the call, contains code/subCode/message.

isMuted

Whether this remote participant is muted or not.

isSpeaking

Whether this remote participant is speaking or not.

role

Get the role of this remote participant.

state

Get state of this remote participant.

videoStreams

Collection of video streams this participants has.

Inherited Properties

displayName

Optional display name, if it was set by the endpoint of that remote participant.

endpointDetails

Get the details of all the endpoints for this remote participant

identifier

Get the identifier for this remote participant.

Methods

mute()

Mute microphone of this remote participant.

off("displayNameChanged", PropertyChangedEvent)

Unsubscribe function for displayNameChanged event.

off("isMutedChanged", PropertyChangedEvent)

Unsubscribe function for isMutedChanged event.

off("isSpeakingChanged", PropertyChangedEvent)

Unsubscribe function for isSpeakingChanged event.

off("roleChanged", PropertyChangedEvent)

Unsubscribe function for roleChanged event.

off("stateChanged", PropertyChangedEvent)

Unsubscribe function for stateChanged event.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Unsubscribe function for videoStreamsUpdated event.

on("displayNameChanged", PropertyChangedEvent)

Subscribe function for displayNameChanged event.

on("isMutedChanged", PropertyChangedEvent)

Subscribe function for isMutedChanged event.

on("isSpeakingChanged", PropertyChangedEvent)

Subscribe function for isSpeakingChanged event.

on("roleChanged", PropertyChangedEvent)

Subscribe function for roleChanged event.

on("stateChanged", PropertyChangedEvent)

Subscribe function for stateChanged event.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Subscribe function for videoStreamsUpdated event.

Property Details

callEndReason

Reason why participant left the call, contains code/subCode/message.

callEndReason?: CallEndReason

Property Value

isMuted

Whether this remote participant is muted or not.

isMuted: boolean

Property Value

boolean

isSpeaking

Whether this remote participant is speaking or not.

isSpeaking: boolean

Property Value

boolean

role

Get the role of this remote participant.

role: ParticipantRole

Property Value

state

Get state of this remote participant.

state: RemoteParticipantState

Property Value

videoStreams

Collection of video streams this participants has.

videoStreams: readonly RemoteVideoStream[]

Property Value

readonly RemoteVideoStream[]

Inherited Property Details

displayName

Optional display name, if it was set by the endpoint of that remote participant.

displayName?: string

Property Value

string

Inherited From ParticipantInfo.displayName

endpointDetails

Get the details of all the endpoints for this remote participant

endpointDetails: EndpointDetails[]

Property Value

Inherited From ParticipantInfo.endpointDetails

identifier

Get the identifier for this remote participant.

identifier: CommunicationIdentifierKind

Property Value

Inherited From ParticipantInfo.identifier

Method Details

mute()

Mute microphone of this remote participant.

function mute(): Promise<void>

Returns

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Unsubscribe function for displayNameChanged event.

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

Parameters

event

"displayNameChanged"

event name.

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("isMutedChanged", PropertyChangedEvent)

Unsubscribe function for isMutedChanged event.

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

Parameters

event

"isMutedChanged"

event name.

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("isSpeakingChanged", PropertyChangedEvent)

Unsubscribe function for isSpeakingChanged event.

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

Parameters

event

"isSpeakingChanged"

event name.

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("roleChanged", PropertyChangedEvent)

Unsubscribe function for roleChanged event.

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

Parameters

event

"roleChanged"

event name.

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("stateChanged", PropertyChangedEvent)

Unsubscribe function for stateChanged event.

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

Parameters

event

"stateChanged"

event name.

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Unsubscribe function for videoStreamsUpdated event.

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

Parameters

event

"videoStreamsUpdated"

event name.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn that was used to subscribe to this event.

on("displayNameChanged", PropertyChangedEvent)

Subscribe function for displayNameChanged event.

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

Parameters

event

"displayNameChanged"

event name.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isMutedChanged", PropertyChangedEvent)

Subscribe function for isMutedChanged event.

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

Parameters

event

"isMutedChanged"

event name.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("isSpeakingChanged", PropertyChangedEvent)

Subscribe function for isSpeakingChanged event.

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

Parameters

event

"isSpeakingChanged"

event name.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("roleChanged", PropertyChangedEvent)

Subscribe function for roleChanged event.

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

Parameters

event

"roleChanged"

event name.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("stateChanged", PropertyChangedEvent)

Subscribe function for stateChanged event.

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

Parameters

event

"stateChanged"

event name.

listener
PropertyChangedEvent

callback fn that will be called when value of this property will change.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Subscribe function for videoStreamsUpdated event.

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

Parameters

event

"videoStreamsUpdated"

event name.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn that will be called when this collection will change, it will pass arrays of added and removed elements.