Quick start

Integrate the SDK

Add ZegoUIKitPrebuiltCall as dependencies

Run the following code in your project root directory :

flutter pub add zego_uikit_prebuilt_call

Import the SDK

Now in your Dart code, ​​​​​​​​​​​​​​​​​import the prebuilt Call Kit SDK.

​​​​​​​​​​​​​​​​import 'package:zego_uikit_prebuilt_call/zego_uikit_prebuilt_call.dart';

Using the ZegoUIKitPrebuiltCall in your project

• Go to ZEGOCLOUD Admin Console , get the appID and appSign of your project.

• Specify the userID and userName for connecting the Call Kit service.

• Create a callID that represents the call you want to make.

• userID and callID can only contain numbers, letters, and underlines (_).

• Users that join the call with the same callID can talk to each other.

class CallPage extends StatelessWidget {
  const CallPage({Key? key, required this.callID}) : super(key: key);
  final String callID;

  @override
  Widget build(BuildContext context) {
    return ZegoUIKitPrebuiltCall(
      appID: yourAppID, // Fill in the appID that you get from ZEGOCLOUD Admin Console.
      appSign: yourAppSign, // Fill in the appSign that you get from ZEGOCLOUD Admin Console.
      userID: 'user_id',
      userName: 'user_name',
      callID: callID,
      // You can also use groupVideo/groupVoice/oneOnOneVoice to make more types of calls.
      config: ZegoUIKitPrebuiltCallConfig.oneOnOneVideoCall(),
    );
  }
}

Now, you can make a new call by navigating to this CallPage.

Configure your project

Android

1. Modify the compileSdkVersion to 33 in the your_project/android/app/build.gradle file.

   

2. Modify the minSdkVersion in the same file:

   minSdkVersion 21
   

   1

   Copy
   

3. Modify the kotlin version to >= 1.8.0 and the gradle classpath version to 7.3.0 in the your_project/android/app/build.gradle file:

   buildscript {
       ext.kotlin_version = '1.8.0'
       repositories {
           google()
           mavenCentral()
       }
   
       dependencies {
           classpath 'com.android.tools.build:gradle:7.3.0'
           classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
   
           // support notification
           classpath 'com.google.gms:google-services:4.3.14'
       }
   }
   

   1

   Copy

4. Make the gradle version >= 7.0: In the your_project/android/gradle/wrapper/gradle-wrapper.properties file, modify the distributionUrl to https://services.gradle.org/distributions/gradle-7.4-all.zip.

   distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip
   

   1

   Copy
   

5. Add app permissions.

   Open the file your_project/app/src/main/AndroidManifest.xml, and add the following code:

   1

   Copy
   

6. Prevent code obfuscation.

   In your project's your_project > android > app folder, create a proguard-rules.pro file with the following content as shown below:

   -keep class **.zego.** { *; }
   

   1

   Copy

   Add the following config code to the release part of the your_project/android/app/build.gradle file.

   proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
   

   1

   Copy

iOS

1. Add app permissions.

   Open the your_project/ios/Podfile file, and add the following to the post_install do |installer| part:

   # Start of the permission_handler configuration
   target.build_configurations.each do |config|
     config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
       '$(inherited)',
       'PERMISSION_CAMERA=1',
       'PERMISSION_MICROPHONE=1',
     ]
   end
   # End of the permission_handler configuration
   

   1

   Copy
   

2. Open the your_project/ios/Runner/Info.plist file, and add the following to the dict part:

   NSCameraUsageDescription
       We require camera access to connect
       NSMicrophoneUsageDescription
       We require microphone access to connect
   

   1

   Copy
   

3. Disable Build Libraries for Distribution

   Open the your_project > iOS > Runner.xcworkspace file.

   Select your target project, and follow the notes on the following image to disable the Build Libraries for Distribution.

   

Run & Test

Now you have finished all the steps!

You can simply click the Run or Debug to run and test your App on your device.

Related guide and resources

• Sample code

• API reference