Documentation

Class: RemoteParticipant

RemoteParticipant

A RemoteParticipant represents a remote Participant in a Room.

Properties:
Name Type Description
audioTracks Map.<Track.SID, RemoteAudioTrack>

The Participant's RemoteAudioTracks
audioTrackPublications Map.<Track.SID, RemoteAudioTrackPublication>

The Participant's RemoteAudioTrackPublications
dataTracks Map.<Track.SID, RemoteDataTrack>

The Participant's RemoteDataTracks
dataTrackPublications Map.<Track.SID, RemoteDataTrackPublication>

The Participant's RemoteDataTrackPublications
tracks Map.<Track.SID, RemoteTrack>

The Participant's RemoteTracks
trackPublications Map.<Track.SID, RemoteTrackPublication>

The Participant's RemoteTrackPublications
videoTracks Map.<Track.SID, RemoteVideoTrack>

The Participant's RemoteVideoTracks
videoTrackPublications Map.<Track.SID, RemoteVideoTrackPublication>

The Participant's RemoteVideoTrackPublications
Fires:

Extends

Events

disconnected

The Participant has disconnected.

Parameters:
Name Type Description
participant Participant

The Participant that disconnected.
Inherited From:

trackAdded

A RemoteTrack was added by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was added
Overrides:

trackDimensionsChanged

One of the RemoteParticipant's RemoteVideoTrack's dimensions changed.

Parameters:
Name Type Description
track RemoteVideoTrack

The RemoteVideoTrack whose dimensions changed
Overrides:

trackDisabled

A RemoteTrack was disabled by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was disabled
Overrides:

trackEnabled

A RemoteTrack was enabled by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was enabled
Overrides:

trackMessage

A message was received over one of the RemoteParticipant's RemoteDataTracks.

Parameters:
Name Type Description
data string | ArrayBuffer
track RemoteDataTrack

The RemoteDataTrack over which the message was received

trackPublished

A RemoteTrack was published by the RemoteParticipant.

Parameters:
Name Type Description
publication RemoteTrackPublication

The RemoteTrackPublication which represents the published RemoteTrack

trackRemoved

A RemoteTrack was removed by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was removed
Overrides:

trackStarted

One of the RemoteParticipant's RemoteTracks started.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that started
Overrides:

trackSubscribed

A RemoteParticipant's RemoteTrack was subscribed to.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was subscribed to

trackSubscriptionFailed

A RemoteParticipant's RemoteTrack could not be subscribed to.

Parameters:
Name Type Description
error TwilioError

The reason the RemoteTrack could not be subscribed to
publication RemoteTrackPublication

The RemoteTrackPublication for the RemoteTrack that could not be subscribed to

trackUnpublished

A RemoteTrack was unpublished by the RemoteParticipant.

Parameters:
Name Type Description
publication RemoteTrackPublication

The RemoteTrackPublication which represents the unpublished RemoteTrack

trackUnsubscribed

A RemoteParticipant's RemoteTrack was unsubscribed from.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was unsubscribed from