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.

Swift
Objective-C

let callSession = CallSession.shared

CallSession *callSession = [CallSession shared];

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

Mute Audio

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

Swift
Objective-C

CallSession.shared.muteAudio()

[[CallSession shared] muteAudio];

Unmute Audio

Unmutes your local microphone, resuming audio transmission.

Swift
Objective-C

CallSession.shared.unmuteAudio()

[[CallSession shared] unmuteAudio];

Set Audio Mode

Changes the audio output device during a call.

Swift
Objective-C

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

[[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
Objective-C

CallSession.shared.pauseVideo()

[[CallSession shared] pauseVideo];

Resume Video

Turns on your local camera, resuming video transmission.

Swift
Objective-C

CallSession.shared.resumeVideo()

[[CallSession shared] resumeVideo];

Switch Camera

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

Swift
Objective-C

CallSession.shared.switchCamera()

[[CallSession shared] switchCamera];

Start Recording

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

Swift
Objective-C

CallSession.shared.startRecording()

[[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
Objective-C

CallSession.shared.stopRecording()

[[CallSession shared] stopRecording];

Mute Participant

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

Swift
Objective-C

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

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

Pause Participant Video

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

Swift
Objective-C

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

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

Pin Participant

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

Swift
Objective-C

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

[[CallSession shared] pinParticipantWithParticipantId:@"PARTICIPANT_UID" type:@"pin"];

Unpin Participant

Removes the pin, returning to automatic speaker highlighting.

Swift
Objective-C

CallSession.shared.unpinParticipant()

[[CallSession shared] unpinParticipant];

Set Layout

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

Swift
Objective-C

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

[[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
Objective-C

CallSession.shared.enablePictureInPictureLayout()

[[CallSession shared] enablePictureInPictureLayout];

Disable Picture In Picture Layout

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

Swift
Objective-C

CallSession.shared.disablePictureInPictureLayout()

[[CallSession shared] disablePictureInPictureLayout];

Set Chat Button Unread Count

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

Swift
Objective-C

CallSession.shared.setChatButtonUnreadCount(5)

[[CallSession shared] setChatButtonUnreadCount:5];

Is Session Active

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

Swift
Objective-C

let isActive = CallSession.shared.isCallSessionActive()

BOOL isActive = [[CallSession shared] isCallSessionActive];

Leave Session

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

Swift
Objective-C

CallSession.shared.leaveSession()

[[CallSession shared] leaveSession];

Raise Hand

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

Swift
Objective-C

CallSession.shared.raiseHand()

[[CallSession shared] raiseHand];

Lower Hand

Removes the hand-raised indicator.

Swift
Objective-C

CallSession.shared.lowerHand()

[[CallSession shared] lowerHand];

Hide Settings Panel

Hides the settings panel if it’s currently visible.

Swift
Objective-C

CallSession.shared.hideSettingsPanel()

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

​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

​Hide Settings Panel

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

Hide Settings Panel