Setup

CometChat Calling SDK v4 - Legacy Release - Setup for Flutter

You’re reading the legacy documentation for Calling SDK v4 (Flutter).

Follow this page only if your app is on v4.x. If you’re using v5, see the Calling SDK v5 documentation instead.

Ready to move off v4? Follow the v4 → v5 migration guide.

Get your Application Keys

Signup for CometChat and then:

1. Create a new app
2. Head over to the API Keys section and note the Auth Key, App ID & Region

Minimum Requirement For Calling

• Android API level 24 and above
• iOS version 12 and above

Add the CometChatCalls Dependency

1. Add the following code in your pubspec.yaml file and run pub get command.

Dart

  cometchat_calls_sdk: ^4.2.2

2. Import CometChatCalls using following code in dart

Dart

import 'package:cometchat_calls_sdk/cometchat_calls_sdk.dart';  

Initialise CometChatCalls

The init() method initialises the settings required for CometChatCalls. The init() method takes the below parameters:

1. callAppSettings - An object of the CallAppSettings class can be created using the CallAppSettingBuilder class. The appId and region field is mandatory and can be set using the setAppId() and setRegion() method.

The CallAppSettings class allows you to configure three settings:

• App ID: CometChat app ID.
• Region: The region where you app was created.
• Host(host: string): This method takes the client URL as input and uses this client URL instead of the default client URL. This can be used in case of dedicated deployment of CometChat.

We suggest you call the init() method on activity onCreate() method.

Dart

CallAppSettings callAppSettings= (CallAppSettingBuilder()
..appId = "xxxxxxxxxx"
..region= "xxxxxxxxxx"
  //..host = "xxxxxxxxx"
).build();
CometChatCalls.init(callAppSettings, onSuccess: (String successMessage) {
debugPrint("Initialization completed successfully  $successMessage");
}, onError: (CometChatCallsException e) {
debugPrint("Initialization failed with exception: ${e.message}");
});

Parameter	Description
callAppSettings	An object of the CallAppSettings class