Call Kit

Live Streaming Kit

Live Audio Room Kit

In-app Chat Kit

Video Conference Kit

音视频通话 UIKit

互动直播 UIKit

语聊房 UIKit

IMKit

UIKit

Overview

Quick start

Quick start (with call invitation)

Add custom components

Configure layouts

Hide the label on the user view

Implement an audio-only call

Customize the menu bar

Set a hangup confirmation dialog

Call invitation config

Calculate call duration

Calling config

Minimize call window

Advanced Features

Event

Config

API Reference

Before you attempt to integrate the SDK, make sure that the development environment meets the following requirements:

import Content from "/snippets/uikit/iOSEnviromentRequiremenEn.md"

# Quick start

<Video src="https://www.youtube.com/embed/LQXjqmWrQzI"/>

## Prepare the environment

<Content/>

## Integrate the SDK

### Add ZegoUIKitPrebuiltCall 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 'ZegoUIKitPrebuiltCall'
    ```
- In Terminal, run the following to download all required dependencies and SDK with Cocoapods:
    ```
    pod install
    ```

### Import ZegoUIKit & ZegoUIKitPrebuiltCall to your project

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

### Using the ZegoUIKitPrebuiltCallVC in your project

- Go to [ZEGOCLOUD Admin Console](https://console.zegocloud.com/), 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. 

<Note title="Note">

- `userID` and `callID` can only contain numbers, letters, and underlines (_). 
- Users that join the call with the same `callID` can talk to each other. 
</Note>

```swift
// YourViewController.swift
class ViewController: UIViewController {
    // Other code...
    var userID: String = <#UserID#>
    var userName: String = <#UserName#>
    var callID: String = <#CallID#>
    
    @IBAction func makeNewCall(_ sender: Any) {
        
        // You can also use groupVideo/groupVoice/oneOnOneVoice to make more types of calls.
        let config: ZegoUIKitPrebuiltCallConfig = ZegoUIKitPrebuiltCallConfig.oneOnOneVideoCall()

        let callVC = ZegoUIKitPrebuiltCallVC.init(yourAppID, 
                                                  appSign: yourAppSign, 
                                                  userID: self.userID, 
                                                  userName: self.userName, 
                                                  callID: self.callID, 
                                                  config: config)
        callVC.modalPresentationStyle = .fullScreen
        self.present(callVC, animated: true, completion: nil)
    }
}
```

Then, you can make a new call by presenting the `VC`.

## Configure your project


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

```plist Info.plist
<key>NSCameraUsageDescription</key>
<string>We require camera access to connect to a call</string>
<key>NSMicrophoneUsageDescription</key>
<string>We require microphone access to connect to a call</string>
```

<Frame width="512" height="auto" caption="">
  <img src="https://storage.zego.im/sdk-doc/Pics/ZegoUIKit/Flutter/live/permission_ios.png" />
</Frame>





## 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.



## Related guide

[Custom prebuilt UI](./04-Calling%20config/01-Overview.mdx)

## Resources

<CardGroup cols={2}>
    <Card title="Sample code" href="https://github.com/ZEGOCLOUD/zego_uikit_prebuilt_call_example_ios">
        Click here to get the complete sample code.
    </Card>
</CardGroup>