如何将 ZegoUIKit 集成到您的项目中

在此文档中，我们创建一个新的 iOS 应用项目来介绍如何集成

安装 Pods

1. 打开终端，导航到 Demo 文件夹并运行 pod init 命令。

2. 为 ZegoUIKit 添加依赖项：pod 'ZegoExpressEngine'

3. 运行 pod install 命令以安装所有所需的依赖项。

   

添加 ZegoUIKit 到项目中

1. 在 Xcode 中打开 .xcworkspace 文件

   

2. 解压 ZegoUIKit.zip 并将其放置在与项目根目录相同的级别†

3. 在 info.plist 文件中配置相机和麦克风权限支持

   

集成 ZegoUIKitPrebuiltCall

class ViewController: UIViewController {

  override func viewDidLoad() {

	   super.viewDidLoad()
	   // Do any additional setup after loading the view.
  }

  @IBAction func startCall(_ sender: Any) {
    let config: ZegoUIkitPrebuiltCallConfig = ZegoUIkitPrebuiltCallConfig()
    let callVC: ZegoUIKitPrebuiltCallVC = ZegoUIKitPrebuiltCallVC.init(YOUR_APPID, appSign: YOUR_APP_Sign, userID: "userID", userName: "UserName", callID: "callID", config: config)
    callVC.modalPresentationStyle = .fullScreen
    callVC.delegate = self
    self.present(callVC, animated: true, completion: nil)     
  }
}

extension ViewController: ZegoUIKitPrebuiltCallVCDelegate {
    func onHangUp(_ isHandup: Bool) {
        // Triggered when hanging up 
    }
    
    func getForegroundView(_ userInfo: ZegoUIkitUser?) -> UIView? {
        // You can add your custom ForegroundView on top of AudioVideoView here
    }
    
    func onOnlySelfInRoom() {
        //You're the only person on the line right now
    }
    
}

功能提示

1. 支持点击无响应区域隐藏菜单栏
2. 支持显示音频通话模式中的声音波
3. 支持点击小视图交换为大视图
4. 支持拖动小视图位置

更多功能请参阅高级配置属性列表

自定义

1. 自定义音频视频视图的背景图

   //Set before initializing ZegoUIKitPrebuiltCallVC
   let config: ZegoUIkitPrebuiltCallConfig = ZegoUIkitPrebuiltCallConfig()
   let layoutConfig: ZegoLayout = ZegoLayout()
   let pictureInPictureConfig: ZegoLayoutPictureInPictureConfig = ZegoLayoutPictureInPictureConfig()
   pictureInPictureConfig.bigViewBackgroundImage = YOUR_CUSTOM_IMAGE// set your custom image
   pictureInPictureConfig.smallViewBackgroundImage = YOUR_CUSTOM_IMAGE // set your custom image
   layoutConfig.config = pictureInPictureConfig
   layoutConfig.mode = .pictureInPicture
   config.layout = layoutConfig

2. 自定义音频视频视图的背景色

   //Set before initializing ZegoUIKitPrebuiltCallVC
   let config: ZegoUIkitPrebuiltCallConfig = ZegoUIkitPrebuiltCallConfig()
   let layoutConfig: ZegoLayout = ZegoLayout()
   let pictureInPictureConfig: ZegoLayoutPictureInPictureConfig = ZegoLayoutPictureInPictureConfig()
   pictureInPictureConfig.bigViewBackgroundColor = YOUR_CUSTOM_IMAGE// set your custom image
   pictureInPictureConfig.smallViewBackgroundColor = YOUR_CUSTOM_IMAGE // set your custom image
   layoutConfig.config = pictureInPictureConfig
   layoutConfig.mode = .pictureInPicture
   config.layout = layoutConfig

3. 自定义音频视频视图的前景

   class ViewController: UIViewController {
     
     func startCall() {
       let callVC: ZegoUIKitPrebuiltCallVC = ZegoUIKitPrebuiltCallVC.init(YOUR_APPID, appSign: "YOUR_APP_Sign", 		 		userID: "userID", userName: "UserName", callID: "callID", config: config)
   		 callVC.delegate = self //set delegate
     }
     
   }
   
   //Implementing the proxy method
   extension ViewController: ZegoUIKitPrebuiltCallVCDelegate {
       func getForegroundView(_ userInfo: ZegoUIkitUser?) -> UIView? {
           let customView: UIView = UIView()
           return customView
       }
   }

4. 自定义菜单栏按钮

   //Set before initializing ZegoUIKitPrebuiltCallVC
   let config: ZegoUIkitPrebuiltCallConfig = ZegoUIkitPrebuiltCallConfig()
   config.menuBarButtons = [.quitButton,.swtichAudioOutputButton,.toggleMicrophoneButton]

5. 将系统按钮添加到菜单栏

   let callVC: ZegoUIKitPrebuiltCallVC
   let button: UIButton = UIButton()
   button.addTarget(self, action: #selector(buttonClick), for: .touchUpInside)
   callVC.addButtonToMenuBar(button)
   
   @objc func buttonClick() {
        // button click event
   }

6. 将组件按钮添加到菜单栏

   let callVC: ZegoUIKitPrebuiltCallVC
   let button: ZegoLeaveButton = ZegoLeaveButton()
   callVC.addButtonToMenuBar(button)

高级配置

您可以修改更多的高级配置属性，例如 config.turnOnCameraWhenJoining = false;，用法示例

//Set before initializing ZegoUIKitPrebuiltCallVC
let config: ZegoUIkitPrebuiltCallConfig = ZegoUIkitPrebuiltCallConfig()
config.turnOnCameraWhenjoining = false
let callVC: ZegoUIKitPrebuiltCallVC =  ZegoUIKitPrebuiltCallVC.init(YOUR_APPID, appSign: "YOUR_APP_Sign", userID: "userID", userName: "UserName", callID: "callID", config: config)

高级配置属性列表

高级布局配置

每个布局都有一组可配置的参数供您选择

ZegoLayoutPictureInPictureConfig

测试提示

1. 您需要使用真设备进行测试，ios模拟器不支持摄像头。
2. 请注意，在测试时，两个设备不应离得太近，如果您的两个设备距离较近，可能会出现捕捉彼此声音的问题，导致回声震荡。请参阅https://en.wikipedia.org/wiki/Audio_feedback