Video Conference Kit
  • iOS : Swift
  • Android
  • Web
  • Flutter
  • React Native
  • Overview
  • Quick start
  • Customize prebuilt features
    • Overview
    • Add custom components to user view
    • Configure video layouts
    • Hide components
    • Customize the menu bar
    • Set a leave confirmation dialog
    • Turn off cam and mic when joining meeting
    • Implement an audio-only conference
  • Documentation
  • Video Conference Kit
  • Quick start

Quick start

Last updated:2023-06-15 18:32

Integrate the SDK

Add ZegoUIKitPrebuiltVideoConference as dependencies

  • Open Terminal, navigate to your project's root directory, and run the following to create a podfile:
    pod init
  • Edit the Podfile file to add the basic dependency:
    pod 'ZegoUIKitPrebuiltVideoConference'
  • In Terminal, run the following to download all required dependencies and SDK with Cocoapods:
    pod install

Import ZegoUIKit & ZegoUIKitPrebuiltVideoConference to your project

import ZegoUIKit
import ZegoUIKitPrebuiltVideoConference
// YourViewController.swift
class ViewController: UIViewController {
    //Other code...
}

Using the ZegoUIKitPrebuiltVideoConferenceVC 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 conference you want to start.
  • userID and conferenceID can only contain numbers, letters, and underlines (_).
  • Using the same conferenceID will enter the same video conference.
class ViewController: UIViewController {
    var userID: String = <#UserID#>
    var userName: String = <#UserName#>
    var conferenceID: String = <#ConferenceID#>

    @IBAction func enterMeeting(_ sender: Any) {

        let config: ZegoUIKitPrebuiltVideoConferenceConfig = ZegoUIKitPrebuiltVideoConferenceConfig()
        let videoConferenceVC: ZegoUIKitPrebuiltVideoConferenceVC = ZegoUIKitPrebuiltVideoConferenceVC.init(appID, appSign: appSign, userID: userID, userName: userName, conferenceID: conferenceID, config: config)

        videoConferenceVC.modalPresentationStyle = .fullScreen
        self.present(videoConferenceVC, animated: true, completion: nil)
    }
}

Then, you can start a video conference by presenting the VC.

Configure your project

Open the Info.plist, add the following code inside the dict part:

<key>NSCameraUsageDescription</key>
<string>Access permission to camera is required.</string>
<key>NSMicrophoneUsageDescription</key>
<string>Access permission to microphone is required.</string>

/Pics/ZegoUIKit/iOS/add_mic_camera_permissions.png

Run & Test

Now you have finished all the steps!

You can simply click the Run in XCode to run and test your App on your device.

Custom prebuilt UI

Resources

Page Directory