Class: RemoteParticipant

RemoteParticipant

A RemoteParticipant represents a remote Participant in a Room.

Extends

Events


disconnected

The Participant has disconnected.

Parameters:
Name Type Description
participant Participant

The Participant that disconnected.

Inherited From:

networkQualityLevelChanged

Parameters:
Name Type Argument Description
networkQualityLevel NetworkQualityLevel

The new NetworkQualityLevel

networkQualityStats NetworkQualityStats <nullable>

The NetworkQualityStats based on which NetworkQualityLevel is calculated, if any

Inherited From:

trackAdded

A RemoteTrack was added by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was added

Overrides:
Deprecated:
  • Use RemoteParticipant#trackSubscribed instead

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 after connecting to the Room. This event is not emitted for RemoteTracks that were published while the RemoteParticipant was connecting to the Room.

Parameters:
Name Type Description
publication RemoteTrackPublication

The RemoteTrackPublication which represents the published RemoteTrack

Example
function trackPublished(publication) {
  console.log(`Track ${publication.trackSid} was published`);
}

room.on('participantConnected', participant => {
  // Handle RemoteTracks published while connecting to the Room.
  participant.trackPublications.forEach(trackPublished);

  // Handle RemoteTracks published after connecting to the Room.
  participant.on('trackPublished', trackPublished);
});

trackRemoved

A RemoteTrack was removed by the RemoteParticipant.

Parameters:
Name Type Description
track RemoteTrack

The RemoteTrack that was removed

Overrides:
Deprecated:
  • Use RemoteParticipant#trackUnsubscribed instead

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