Participant Management

CometChat Calls SDK v5 — Participant Management

Overview

Control other participants during calls: mute their audio, pause their video, pin/unpin in layout. Monitor participant state via ParticipantEventListener. Raise hand is available for self.

Key Imports

import com.cometchat.calls.core.CallSession
import com.cometchat.calls.listeners.ParticipantEventListener
import com.cometchat.calls.model.Participant

Implementation

Participant Actions

val callSession = CallSession.getInstance()

// Mute a participant's audio
callSession.muteParticipant(participant.uid)

// Pause a participant's video
callSession.pauseParticipantVideo(participant.uid)

// Pin a participant (keeps them prominent in layout)
callSession.pinParticipant(participant.uid, "pin")

// Unpin (return to automatic speaker highlighting)
callSession.unpinParticipant()

Raise/Lower Hand (Self)

val callSession = CallSession.getInstance()

// Raise hand programmatically
callSession.raiseHand()

// Lower hand programmatically
callSession.lowerHand()

Raise hand is also controlled via the built-in UI button. Listen for it:

callSession.addButtonClickListener(this, object : ButtonClickListener() {
    override fun onRaiseHandButtonClicked() {
        Log.d(TAG, "Hand raised/lowered")
    }
    // ... other overrides
})

Listen for Participant Events

callSession.addParticipantEventListener(this, object : ParticipantEventListener() {
    override fun onParticipantJoined(participant: Participant) {}
    override fun onParticipantLeft(participant: Participant) {}
    override fun onParticipantListChanged(participants: List<Participant>) {
        // Full participant list — use for UI updates
    }
    override fun onParticipantAudioMuted(participant: Participant) {}
    override fun onParticipantAudioUnmuted(participant: Participant) {}
    override fun onParticipantVideoPaused(participant: Participant) {}
    override fun onParticipantVideoResumed(participant: Participant) {}
    override fun onParticipantHandRaised(participant: Participant) {}
    override fun onParticipantHandLowered(participant: Participant) {}
    override fun onDominantSpeakerChanged(participant: Participant) {}
    override fun onParticipantStartedScreenShare(participant: Participant) {}
    override fun onParticipantStoppedScreenShare(participant: Participant) {}
    override fun onParticipantStartedRecording(participant: Participant) {}
    override fun onParticipantStoppedRecording(participant: Participant) {}
})

Participant Object Properties

Show/Hide Participant List Button

val sessionSettings = CometChatCalls.SessionSettingsBuilder()
    .hideParticipantListButton(false)  // show participant list
    .hideRaiseHandButton(false)        // show raise hand
    .build()

Gotchas

• By default, all participants have moderator access (can mute/pause others)
• Implement role-based restrictions in your app logic if needed
• Pinning only affects your local view — other participants can pin independently
• unpinParticipant() takes no arguments — unpins whoever is currently pinned
• pinParticipant(uid, type) takes a participant UID and a type string (e.g., "pin")
• raisedHandTimestamp > 0 means hand is raised
• There is no "kick" API — only mute and pause video

Sample App Reference

• CallActivity.kt — setupCallListeners() with ButtonClickListener