Actions

CometChat Calling SDK v5 - Beta Release - Actions for Android

Use call actions to create your own custom controls or trigger call functionality dynamically based on your use case. All actions are called on the CallSession singleton instance during an active call session.

Get CallSession Instance

The CallSession is a singleton that manages the active call. All actions are accessed through this instance.

Kotlin

val callSession = CallSession.getInstance()

Java

CallSession callSession = CallSession.getInstance();

Always check isSessionActive() before calling actions to ensure there’s an active call.

Actions

Mute Audio

Mutes your local microphone, stopping audio transmission to other participants.

Kotlin

callSession.muteAudio()

Java

callSession.muteAudio();

Unmute Audio

Unmutes your local microphone, resuming audio transmission.

Kotlin

callSession.unMuteAudio()

Java

callSession.unMuteAudio();

Set Audio Mode

Changes the audio output device during a call.

Kotlin

callSession.setAudioMode(AudioMode.SPEAKER)
callSession.setAudioMode(AudioMode.EARPIECE)
callSession.setAudioMode(AudioMode.BLUETOOTH)
callSession.setAudioMode(AudioMode.HEADPHONES)

Java

callSession.setAudioMode(AudioMode.SPEAKER);
callSession.setAudioMode(AudioMode.EARPIECE);
callSession.setAudioMode(AudioMode.BLUETOOTH);
callSession.setAudioMode(AudioMode.HEADPHONES);

AudioMode Values

Value	Description
SPEAKER	Routes audio through device loudspeaker
EARPIECE	Routes audio through phone earpiece
BLUETOOTH	Routes audio through connected Bluetooth device
HEADPHONES	Routes audio through wired headphones

Pause Video

Turns off your local camera, stopping video transmission. Other participants see your avatar.

Kotlin

callSession.pauseVideo()

Java

callSession.pauseVideo();

Resume Video

Turns on your local camera, resuming video transmission.

Kotlin

callSession.resumeVideo()

Java

callSession.resumeVideo();

Switch Camera

Toggles between front and back cameras without interrupting the video stream.

Kotlin

callSession.switchCamera()

Java

callSession.switchCamera();

Start Recording

Begins server-side recording of the call. All participants are notified.

Kotlin

callSession.startRecording()

Java

callSession.startRecording();

Recording requires the feature to be enabled for your CometChat app.

Stop Recording

Stops the current recording. The recording is saved and accessible via the dashboard.

Kotlin

callSession.stopRecording()

Java

callSession.stopRecording();

Mute Participant

Mutes a specific participant’s audio. This is a moderator action.

Kotlin

callSession.muteParticipant(participant.uid)

Java

callSession.muteParticipant(participant.getUid());

Pause Participant Video

Pauses a specific participant’s video. This is a moderator action.

Kotlin

callSession.pauseParticipantVideo(participant.uid)

Java

callSession.pauseParticipantVideo(participant.getUid());

Pin Participant

Pins a participant to keep them prominently displayed regardless of who is speaking.

Kotlin

callSession.pinParticipant(participant.uid)

Java

callSession.pinParticipant(participant.getUid());

Unpin Participant

Removes the pin, returning to automatic speaker highlighting.

Kotlin

callSession.unPinParticipant()

Java

callSession.unPinParticipant();

Set Layout

Changes the call layout. Each participant can choose their own layout independently.

Kotlin

callSession.setLayout(LayoutType.TILE)
callSession.setLayout(LayoutType.SPOTLIGHT)
callSession.setLayout(LayoutType.SIDEBAR)

Java

callSession.setLayout(LayoutType.TILE);
callSession.setLayout(LayoutType.SPOTLIGHT);
callSession.setLayout(LayoutType.SIDEBAR);

LayoutType Values

Value	Description
TILE	Grid layout with equally-sized tiles
SPOTLIGHT	Large view for active speaker, small tiles for others
SIDEBAR	Main speaker with participants in a sidebar

Enable Picture In Picture Layout

Enables PiP mode, allowing the call to continue in a floating window.

Kotlin

callSession.enablePictureInPictureLayout()

Java

callSession.enablePictureInPictureLayout();

Disable Picture In Picture Layout

Disables PiP mode, returning to full-screen call interface.

Kotlin

callSession.disablePictureInPictureLayout()

Java

callSession.disablePictureInPictureLayout();

Set Chat Button Unread Count

Updates the badge count on the chat button. Pass 0 to hide the badge.

Kotlin

callSession.setChatButtonUnreadCount(5)

Java

callSession.setChatButtonUnreadCount(5);

Is Session Active

Returns true if a call session is active, false otherwise.

Kotlin

val isActive = callSession.isSessionActive()

Java

boolean isActive = callSession.isSessionActive();

Leave Session

Ends your participation and disconnects gracefully. The call continues for other participants.

Kotlin

callSession.leaveSession()

Java

callSession.leaveSession();

Raise Hand

Shows a hand-raised indicator to get attention from other participants.

Kotlin

callSession.raiseHand()

Java

callSession.raiseHand();

Lower Hand

Removes the hand-raised indicator.

Kotlin

callSession.lowerHand()

Java

callSession.lowerHand();

Participant Object Reference

Property	Type	Description
uid	String	Unique identifier (CometChat user ID)
name	String	Display name
avatar	String	URL of avatar image
pid	String	Participant ID for this call session
role	String	Role in the call
audioMuted	Boolean	Whether audio is muted
videoPaused	Boolean	Whether video is paused
isPinned	Boolean	Whether pinned in layout
isPresenting	Boolean	Whether screen sharing
raisedHandTimestamp	Long	Timestamp when hand was raised