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.shared 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.

let callSession = CallSession.shared

Always check isSessionJoined() before calling in-call actions to ensure you are in a call.

Mute Audio

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

CallSession.shared.muteAudio()

Unmute Audio

Unmutes your local microphone, resuming audio transmission.

CallSession.shared.unmuteAudio()

Set Audio Mode

Changes the audio output device during a call.

CallSession.shared.setAudioMode("SPEAKER")
CallSession.shared.setAudioMode("EARPIECE")
CallSession.shared.setAudioMode("BLUETOOTH")
CallSession.shared.setAudioMode("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.

CallSession.shared.pauseVideo()

Resume Video

Turns on your local camera, resuming video transmission.

CallSession.shared.resumeVideo()

Switch Camera

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

CallSession.shared.switchCamera()

Start Recording

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

CallSession.shared.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.

CallSession.shared.stopRecording()

Start Transcription

Available since v5.0.4 Begins server-side transcription of the call. This also enables the live closed captions overlay.

CallSession.shared.startTranscription()

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

Stop Transcription

Available since v5.0.4 Stops the current transcription and clears any captions currently on screen. The transcript is saved and can be retrieved with TranscriptsRequest.

CallSession.shared.stopTranscription()

Mute Participant

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

guard let uid = participant.uid else { return }
CallSession.shared.muteParticipant(participantId: uid)

Pause Participant Video

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

guard let uid = participant.uid else { return }
CallSession.shared.pauseParticipantVideo(participantId: uid)

Pin Participant

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

CallSession.shared.pinParticipant(participantId: "PARTICIPANT_UID", type: "pin")

Unpin Participant

Removes the pin, returning to automatic speaker highlighting.

CallSession.shared.unpinParticipant()

Set Layout

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

CallSession.shared.setLayout("TILE")
CallSession.shared.setLayout("SPOTLIGHT")
CallSession.shared.setLayout("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.

CallSession.shared.enablePictureInPictureLayout()

Disable Picture In Picture Layout

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

CallSession.shared.disablePictureInPictureLayout()

Set Chat Button Unread Count

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

CallSession.shared.setChatButtonUnreadCount(5)

Is Session Active

isSessionActive() returns true while the SDK owns a session: one being prepared or prepared (for example an outgoing call that is still ringing), one being joined, or a joined one. isSessionJoined() is the narrower “in a call” check: true only once the media session is joined.

let isActive = CallSession.shared.isSessionActive()
let isInCall = CallSession.shared.isSessionJoined()

isCallSessionActive() is deprecated in 5.1 and renamed isSessionActive(). Because it now also covers a prepared session, use isSessionJoined() where you meant “in a call”.

Leave Session

Ends your participation and disconnects gracefully. In a 1:1 call this is the hang-up: the other side receives onParticipantLeft and the backend records the end, and a session joined as a peer call (setPeerCall(true)) ends for both. In a group call the session continues for the other participants. Leaving also cancels a session that is only prepared.

CallSession.shared.leave()

leaveSession() is deprecated in 5.1 and only calls leave(). To end a call that is still ringing use CometChatCalls.endCall(sessionID:status:onSuccess:onError:) with EndCallStatus.cancelled (caller), as described in Ringing; leave() alone does not tell the other side why.

Raise Hand

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

CallSession.shared.raiseHand()

Lower Hand

Removes the hand-raised indicator.

CallSession.shared.lowerHand()

Hide Settings Panel

Hides the settings panel if it’s currently visible.

CallSession.shared.hideSettingsPanel()

Participant Object Reference

Property	Type	Description
`uid`	`String?`	CometChat user ID — the identifier every moderator action takes
`name`	`String?`	Display name
`avatar`	`String?`	URL of avatar image
`mid`	`String?`	Media ID for this call session
`state`	`String?`	Participant state as reported by the server
`isJoined`	`Bool?`	Whether the participant is currently joined
`joinedAt`	`Int?`	Join timestamp
`leftAt`	`Int?`	Leave timestamp
`deviceID`	`String?`	Device identifier
`totalAudioMinutes`	`Double?`	Audio minutes consumed
`totalVideoMinutes`	`Double?`	Video minutes consumed
`totalDurationInMinutes`	`Double?`	Total session minutes

Every property is Optional. Participant carries no mute / video / pin / hand-raise / screen-share flags, and the SDK exposes no getter for them — track that state in your own app from the participant events. Because the events fire only on change, a client that joins late cannot recover state that was already in effect.

Overview

Getting Started

Call Session

Features

Advanced

Migration Guide

Resources

Actions

Get CallSession Instance

Actions

Mute Audio

Unmute Audio

Set Audio Mode

Pause Video

Resume Video

Switch Camera

Start Recording

Stop Recording

Start Transcription

Stop Transcription

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

Hide Settings Panel

​Get CallSession Instance

​Actions

​Mute Audio

​Unmute Audio

​Set Audio Mode

​Pause Video

​Resume Video

​Switch Camera

​Start Recording

​Stop Recording

​Start Transcription

​Stop Transcription

​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

​Hide Settings Panel

Get CallSession Instance

Actions

Mute Audio

Unmute Audio

Set Audio Mode

Pause Video

Resume Video

Switch Camera

Start Recording

Stop Recording

Start Transcription

Stop Transcription

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

Hide Settings Panel