Documentation

Class: Participant

Participant

A Participant represents a remote Client in a Room.

Properties:
Name Type Description
identity Participant.Identity

The identity of the Participant
media Media

The Media this Participant is sharing, if any
sid Participant.SID

The Participant's SID
state string

"connected", "disconnected" or "failed"
Fires:

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.

trackAdded

A Track was added by the Participant.

Parameters:
Name Type Description
track Track

The Track that was added

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

trackStarted

One of the Participant's Tracks started.

Parameters:
Name Type Description
track Track

The Track that started