Actions

CometChat Calling SDK v5 - Beta Release - Actions for iOS

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.

Swift

let callSession = CallSession.shared

Objective-C

CallSession *callSession = [CallSession shared];

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

Actions

Mute Audio

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

Swift

CallSession.shared.muteAudio()

Objective-C

[[CallSession shared] muteAudio];

Unmute Audio

Unmutes your local microphone, resuming audio transmission.

Swift

CallSession.shared.unMuteAudio()

Objective-C

[[CallSession shared] unMuteAudio];

Set Audio Mode

Changes the audio output device during a call.

Swift

CallSession.shared.setAudioMode("SPEAKER")
CallSession.shared.setAudioMode("EARPIECE")
CallSession.shared.setAudioMode("BLUETOOTH")
CallSession.shared.setAudioMode("HEADPHONES")

Objective-C

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

Swift

CallSession.shared.pauseVideo()

Objective-C

[[CallSession shared] pauseVideo];

Resume Video

Turns on your local camera, resuming video transmission.

Swift

CallSession.shared.resumeVideo()

Objective-C

[[CallSession shared] resumeVideo];

Switch Camera

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

Swift

CallSession.shared.switchCamera()

Objective-C

[[CallSession shared] switchCamera];

Start Recording

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

Swift

CallSession.shared.startRecording()

Objective-C

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

Swift

CallSession.shared.stopRecording()

Objective-C

[[CallSession shared] stopRecording];

Mute Participant

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

Swift

CallSession.shared.muteParticipant(participantId: participant.pid)

Objective-C

[[CallSession shared] muteParticipantWithParticipantId:participant.pid];

Pause Participant Video

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

Swift

CallSession.shared.pauseParticipantVideo(participantId: participant.pid)

Objective-C

[[CallSession shared] pauseParticipantVideoWithParticipantId:participant.pid];

Pin Participant

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

Swift

CallSession.shared.pinParticipant()

Objective-C

[[CallSession shared] pinParticipant];

Unpin Participant

Removes the pin, returning to automatic speaker highlighting.

Swift

CallSession.shared.unPinParticipant()

Objective-C

[[CallSession shared] unPinParticipant];

Set Layout

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

Swift

CallSession.shared.setLayout("TILE")
CallSession.shared.setLayout("SPOTLIGHT")
CallSession.shared.setLayout("SIDEBAR")

Objective-C

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

Swift

CallSession.shared.enablePictureInPictureLayout()

Objective-C

[[CallSession shared] enablePictureInPictureLayout];

Disable Picture In Picture Layout

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

Swift

CallSession.shared.disablePictureInPictureLayout()

Objective-C

[[CallSession shared] disablePictureInPictureLayout];

Set Chat Button Unread Count

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

Swift

CallSession.shared.setChatButtonUnreadCount(5)

Objective-C

[[CallSession shared] setChatButtonUnreadCount:5];

Is Session Active

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

Swift

let isActive = CallSession.shared.isCallSessionActive()

Objective-C

BOOL isActive = [[CallSession shared] isCallSessionActive];

Leave Session

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

Swift

CallSession.shared.leaveSession()

Objective-C

[[CallSession shared] leaveSession];

Raise Hand

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

Swift

CallSession.shared.raiseHand()

Objective-C

[[CallSession shared] raiseHand];

Lower Hand

Removes the hand-raised indicator.

Swift

CallSession.shared.lowerHand()

Objective-C

[[CallSession shared] lowerHand];

Hide Settings Panel

Hides the settings panel if it’s currently visible.

Swift

CallSession.shared.hideSettingsPanel()

Objective-C

[[CallSession shared] hideSettingsPanel];

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	Bool	Whether audio is muted
videoPaused	Bool	Whether video is paused
isPinned	Bool	Whether pinned in layout
isPresenting	Bool	Whether screen sharing
raisedHandTimestamp	Int	Timestamp when hand was raised