Call - CometChat Docs

AI Integration Quick Reference

Field	Value
Package	`cometchat_chat_uikit`
Import	`import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';`
Purpose	Integrate CometChat Flutter UI Kit calling with one-on-one and group audio/video calls, setup, initialization, and call events.
Key classes	`CometChatSubscriptionType` · `CometChatUIKit`
Key methods	`addCallListener()` · `init()` · `removeCallListener()`
Related	Call Buttons · Incoming Call · Outgoing Call · Call Logs

Overview

CometChat’s Calls feature allows you to integrate one-on-one and group audio/video calling capabilities into your application. In V6, calling is built into the cometchat_chat_uikit package — no separate calls dependency needed.

Integration

Step 1: Add Dependency

Add the dependency to your pubspec.yaml:

pubspec.yaml

dependencies:
  cometchat_chat_uikit: ^6.0.5

Step 2: Update build.gradle

Set minSdkVersion to at least 26 in android/app/build.gradle:

Groovy

defaultConfig {
    minSdkVersion 26
    targetSdkVersion flutter.targetSdkVersion
    versionCode flutterVersionCode.toInteger()
    versionName flutterVersionName
}

Step 3: Update iOS Podfile

In ios/Podfile, set the minimum iOS version to 15.1:

platform :ios, '15.1'

These are the Calls SDK’s own floors (minSdkVersion 26, platform :ios, '15.1' as of cometchat_calls_sdk 5.0.7), and they apply to every UI Kit app — the kit depends on the Calls SDK unconditionally, so you inherit them even without enabling calling. Gradle and CocoaPods take the maximum across the dependency graph, so a lower value is a build error rather than a warning.

Step 4: Modify UIKitSettings

Activate calling features by setting enableCalls to true in UIKitSettings:

Dart

UIKitSettings uiKitSettings = (UIKitSettingsBuilder()
  ..subscriptionType = CometChatSubscriptionType.allUsers
  ..autoEstablishSocketConnection = true
  ..region = "REGION"
  ..appId = "APP_ID"
  ..authKey = "AUTH_KEY"
  ..enableCalls = true
  ..callingConfiguration = CallingConfiguration()
).build();

CometChatUIKit.init(uiKitSettings: uiKitSettings,
  onSuccess: (successMessage) {},
  onError: (e) {},
);

To allow launching the Incoming Call screen from any widget, provide the navigator key:

Dart

MaterialApp(
  navigatorKey: CallNavigationContext.navigatorKey,
  home: YourHomeScreen(),
)

Listeners

Dart

class _YourClassNameState extends State<YourClassName> with CallListener {
  @override
  void initState() {
    super.initState();
    CometChat.addCallListener(listenerId, this);
  }

  @override
  void dispose() {
    super.dispose();
    CometChat.removeCallListener(listenerId);
  }

  @override
  void onIncomingCallReceived(Call call) {
    debugPrint("onIncomingCallReceived");
  }

  @override
  void onOutgoingCallAccepted(Call call) {
    debugPrint("onOutgoingCallAccepted");
  }

  @override
  void onOutgoingCallRejected(Call call) {
    debugPrint("onOutgoingCallRejected");
  }

  @override
  void onIncomingCallCancelled(Call call) {
    debugPrint("onIncomingCallCancelled");
  }

  @override
  void onCallEndedMessageReceived(Call call) {
    debugPrint("onCallEndedMessageReceived");
  }

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }
}

Features

Incoming Call

The Incoming Call widget lets users receive real-time audio and video calls. When a call is received, it displays caller information with accept/reject options.

Outgoing Call

The Outgoing Call widget manages the outgoing call process. It displays recipient information and call status, and automatically transitions to the ongoing call screen when accepted.

Call Logs

The Call Logs widget displays records of call events including caller, time, and duration.

​Overview

​Integration

​Step 1: Add Dependency

​Step 2: Update build.gradle

​Step 3: Update iOS Podfile

​Step 4: Modify UIKitSettings

​Listeners

​Features

​Incoming Call

​Outgoing Call

​Call Logs

Overview

Integration

Step 1: Add Dependency

Step 2: Update build.gradle

Step 3: Update iOS Podfile

Step 4: Modify UIKitSettings

Listeners

Features

Incoming Call

Outgoing Call

Call Logs