Skip to main content
Manage call participants by muting, pinning, and monitoring their status during a call.

Get Participant List

Listen for participant list changes:

Participant Object

Each participant contains:
PropertyTypeDescription
pidstringParticipant ID (unique per session)
uidstringUser ID
namestringDisplay name
avatarstringAvatar URL (optional)

Pin Participant

Pin a participant to the main view in Sidebar or Spotlight layouts:
ParameterTypeDescription
participantIdstringThe participant’s pid
typestring'human' for video, 'screen-share' for screen share

Unpin Participant

Remove the pinned participant:

Mute Participant

Mute another participant’s audio (requires moderator permissions):

Pause Participant Video

Pause another participant’s video (requires moderator permissions):

Participant Events

Join and Leave

Audio State

Video State

Hand Raised

Screen Sharing

Dominant Speaker

Complete Example