Class: Participant

Participant


Properties:
Name Type Argument Description
audioTracks Map.<Track.ID, AudioTrack>

The Participant's AudioTracks

audioTrackPublications Map.<Track.SID, AudioTrackPublication>

The Participant's AudioTrackPublications

dataTracks Map.<Track.ID, DataTrack>

The Participant's DataTracks

dataTrackPublications Map.<Track.SID, DataTrackPublication>

The Participant's DataTrackPublications.

identity Participant.Identity

The identity of the Participant

networkQualityLevel NetworkQualityLevel <nullable>

The Participant's current NetworkQualityLevel, if any

networkQualityStats NetworkQualityStats <nullable>

The Participant's current NetworkQualityStats, if any

sid Participant.SID

The Participant's SID

state string

"connected", "disconnected" or "failed"

tracks Map.<Track.ID, Track>

The Participant's Tracks

trackPublications Map.<Track.SID, TrackPublication>

The Participant's TrackPublications

videoTracks Map.<Track.ID, VideoTrack>

The Participant's VideoTracks

videoTrackPublications Map.<Track.SID, VideoTrackPublication>

The Participant's VideoTrackPublications

Fires:

Extends

  • EventEmitter

Type Definitions


Identity

A Participant.Identity is a string that identifies a Participant. You can think of it like a name.

Type:
  • string

SID

A Participant.SID is a 34-character string starting with "PA" that uniquely identifies a Participant.

Type:
  • string

Events


disconnected

The Participant has disconnected.

Parameters:
Name Type Description
participant Participant

The Participant that disconnected.


networkQualityLevelChanged

Parameters:
Name Type Argument Description
networkQualityLevel NetworkQualityLevel

The new NetworkQualityLevel

networkQualityStats NetworkQualityStats <nullable>

The NetworkQualityStats based on which NetworkQualityLevel is calculated, if any


trackAdded

A Track was added by the Participant.

Parameters:
Name Type Description
track Track

The Track that was added

Deprecated:
  • Yes

trackDimensionsChanged

One of the Participant's VideoTrack's dimensions changed.

Parameters:
Name Type Description
track VideoTrack

The VideoTrack whose dimensions changed


trackDisabled

A Track was disabled by the Participant.

Parameters:
Name Type Description
track Track

The Track that was disabled.


trackEnabled

A Track was enabled by the Participant.

Parameters:
Name Type Description
track Track

The Track that was enabled


trackRemoved

A Track was removed by the Participant.

Parameters:
Name Type Description
track Track

The Track that was removed

Deprecated:
  • Yes

trackStarted

One of the Participant's Tracks started.

Parameters:
Name Type Description
track Track

The Track that started