Quick start

Integrate the SDK

1. Add ZegoUIKitPrebuiltVideoConference as dependencies

   Run the following code in your project root directory:

   Untitled

   flutter pub add zego_uikit_prebuilt_video_conference
   

   1

   Copied!

2. Import the SDK

   Now in your Dart code, import the prebuilt Video Conference Kit SDK.

   Untitled

   import 'package:zego_uikit_prebuilt_video_conference/zego_uikit_prebuilt_video_conference.dart';
   

   1

   Copied!

3. Using the ZegoUIKitPrebuiltVideoConference in your project

   • Go to ZEGOCLOUD Admin Console, get the appID and appSign of your project.
   • Specify the userID and userName for connecting the Video Conference Kit service.
   • Create a conferenceID that represents the video conference you want to start.
   Note

   • userID and conferenceID can only contain numbers, letters, and underlines (_).
   • Using the same conferenceID will enter the same video conference.
   Untitled

   class VideoConferencePage extends StatelessWidget {
     final String conferenceID;
   
     const VideoConferencePage({
       Key? key,
       required this.conferenceID,
     }) : super(key: key);
   
     @override
     Widget build(BuildContext context) {
       return SafeArea(
       
         child: ZegoUIKitPrebuiltVideoConference(
           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',
           conferenceID: conferenceID,
           config: ZegoUIKitPrebuiltVideoConferenceConfig(),
         ),
   
       );
     }
   }
   

   1

   Copied!

Now, you can start a video conference by navigating to this VideoConferencePage .

Configure your project

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

Custom prebuilt UI

Resources

Click here to get the complete sample code.

Click here for detailed explanations of all APIs.