RemoteParticipant interface
Represents a remote participant in a call.
Properties
| call |
Reason why participant left the call, contains code/subCode/message. |
| display |
Optional display name, if it was set by the endpoint of that remote participant |
| identifier | Get the identifier for this remote participant. Same as the one used to provision token for another user |
| is |
Whether this remote participant is muted or not |
| is |
|
| state | Get state of this remote participant. |
| video |
Collection of video streams this participants has. |
Methods
| off("display |
Unsubscribe function for displayNameChanged event |
| off("is |
Unsubscribe function for isMutedChanged event |
| off("is |
Unsubscribe function for isSpeakingChanged event |
| off("state |
Unsubscribe function for stateChanged event |
| off("video |
Unsubscribe function for videoStreamsUpdated event |
| on("display |
Subscribe function for displayNameChanged event |
| on("is |
Subscribe function for isMutedChanged event |
| on("is |
Subscribe function for isSpeakingChanged event |
| on("state |
Subscribe function for stateChanged event |
| on("video |
Subscribe function for videoStreamsUpdated event |
Property Details
callEndReason
Reason why participant left the call, contains code/subCode/message.
callEndReason?: CallEndReasonProperty Value
displayName
Optional display name, if it was set by the endpoint of that remote participant
displayName?: stringProperty Value
string
identifier
Get the identifier for this remote participant. Same as the one used to provision token for another user
identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKindProperty Value
CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind
isMuted
Whether this remote participant is muted or not
isMuted: booleanProperty Value
boolean
isSpeaking
isSpeaking: booleanProperty Value
boolean
state
Get state of this remote participant.
state: RemoteParticipantStateProperty Value
videoStreams
Collection of video streams this participants has.
videoStreams: ReadonlyArray<RemoteVideoStream>Property Value
ReadonlyArray<RemoteVideoStream>
Method Details
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("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
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("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
callback fn that will be called when this collection will change, it will pass arrays of added and removed elements