Actions

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
Java

val callSession = CallSession.getInstance()

CallSession callSession = CallSession.getInstance();

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

Mute Audio

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

Kotlin
Java

callSession.muteAudio()

callSession.muteAudio();

Unmute Audio

Unmutes your local microphone, resuming audio transmission.

Kotlin
Java

callSession.unMuteAudio()

callSession.unMuteAudio();

Set Audio Mode

Changes the audio output device during a call.

Kotlin
Java

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

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
Java

callSession.pauseVideo()

callSession.pauseVideo();

Resume Video

Turns on your local camera, resuming video transmission.

Kotlin
Java

callSession.resumeVideo()

callSession.resumeVideo();

Switch Camera

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

Kotlin
Java

callSession.switchCamera()

callSession.switchCamera();

Start Recording

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

Kotlin
Java

callSession.startRecording()

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
Java

callSession.stopRecording()

callSession.stopRecording();

Mute Participant

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

Kotlin
Java

callSession.muteParticipant(participant.uid)

callSession.muteParticipant(participant.getUid());

Pause Participant Video

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

Kotlin
Java

callSession.pauseParticipantVideo(participant.uid)

callSession.pauseParticipantVideo(participant.getUid());

Pin Participant

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

Kotlin
Java

callSession.pinParticipant(participant.uid)

callSession.pinParticipant(participant.getUid());

Unpin Participant

Removes the pin, returning to automatic speaker highlighting.

Kotlin
Java

callSession.unPinParticipant()

callSession.unPinParticipant();

Set Layout

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

Kotlin
Java

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

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
Java

callSession.enablePictureInPictureLayout()

callSession.enablePictureInPictureLayout();

Disable Picture In Picture Layout

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

Kotlin
Java

callSession.disablePictureInPictureLayout()

callSession.disablePictureInPictureLayout();

Set Chat Button Unread Count

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

Kotlin
Java

callSession.setChatButtonUnreadCount(5)

callSession.setChatButtonUnreadCount(5);

Is Session Active

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

Kotlin
Java

val isActive = callSession.isSessionActive()

boolean isActive = callSession.isSessionActive();

Leave Session

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

Kotlin
Java

callSession.leaveSession()

callSession.leaveSession();

Raise Hand

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

Kotlin
Java

callSession.raiseHand()

callSession.raiseHand();

Lower Hand

Removes the hand-raised indicator.

Kotlin
Java

callSession.lowerHand()

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

​Get CallSession Instance

​Actions

​Mute Audio

​Unmute Audio

​Set Audio Mode

​Pause Video

​Resume Video

​Switch Camera

​Start Recording

​Stop Recording

​Mute Participant

​Pause Participant Video

​Pin Participant

​Unpin Participant

​Set Layout

​Enable Picture In Picture Layout

​Disable Picture In Picture Layout

​Set Chat Button Unread Count

​Is Session Active

​Leave Session

​Raise Hand

​Lower Hand

Get CallSession Instance

Actions

Mute Audio

Unmute Audio

Set Audio Mode

Pause Video

Resume Video

Switch Camera

Start Recording

Stop Recording

Mute Participant

Pause Participant Video

Pin Participant

Unpin Participant

Set Layout

Enable Picture In Picture Layout

Disable Picture In Picture Layout

Set Chat Button Unread Count

Is Session Active

Leave Session

Raise Hand

Lower Hand