Participant
Summary
Participant base class for local and remote participants.Properties
identity
Participant's assigned identity (retrieved from the JWT token).
Type
stringisSpeaking
True if the participant is currently speaking
Type
booleanisSpeakingLevel
The current audio level estimate of a speaker between 0 and 1.0, 1 being loudest,
0 being softest.
Remarks
This member is only updated when the order of loudest speakers changes.Type
numberlastSpokeAt
optional
Date when participant last spoke
Date when participant last spoke
Type
Datemetadata
optional
Participant's metadata.
Participant's metadata.
Type
stringname
optional
Participant's assigned display name (retrieved from the JWT token).
Participant's assigned display name (retrieved from the JWT token).
Type
stringpermissions
optional
Participant's permissions.
Participant's permissions.
Type
ParticipantPermissionsid
Server assigned unique id
Type
stringAccessors
connectionQuality
Returns the current connection quality of the participant.
Type
ConnectionQualityisCameraEnabled
True if the participant has enabled their camera.
Type
booleanisLocal
Returns true if this instance is the local participant.
Type
booleanisMicrophoneEnabled
True if the participant has enabled their microphone.
Type
booleanisScreenShareEnabled
True if the participant is currently sharing their screen.
Type
booleanjoinedAt
Date when the participant joined the room.
Type
undefined | DateMethods
getTrack
Finds the first track that matches the source filter, for example, getting
the user's camera track with getTrack(Track.Source.Camera).
Signature
getTrack(source: Track.Source)| Name | Type | Description |
|---|---|---|
source | Track.Source |
getTrackByName
Finds the first track that matches the track's name.
Signature
getTrackByName(name: string)| Name | Type | Description |
|---|---|---|
name | string |
getTracks
Returns a list of all tracks published by the participant.
Signature
getTracks()Returns
TrackPublication[]