实时音视频

实时语音

超低延迟直播

即时通讯

互动核心产品

音视频通话 UIKit

互动直播 UIKit

语聊房 UIKit

IMKit

UIKits

超级白板

云端播放器

AI 美颜

云端录制

小游戏平台

本地服务端录制

星图

互动扩展服务

数字人 PaSS 服务

AIGC

数美内容审核

大饼 AI 变声

实时传译

云市场

产品

语聊房

秀场直播

在线 KTV

在线健身

互动播客

社交娱乐

小班课

大班课

在线音乐教学

在线美术教学

在线编程教学

在线教育

远程医疗

医疗健康

语音通话

视频通话

视频会议

协同办公

解决方案

控制台

安全合规

术语表

ZEGO 平台

通用文档

概述

功能地图

快速开始

快速开始（包含呼叫邀请）

概览

切换语言

添加自定义 UI 组件

调整布局

隐藏用户视图上的标签

实现纯语音互动

自定义菜单栏

实现挂断确认对话框

呼叫邀请配置

计算通话时长

通话设置

集成 Apple VoIP

实现离线呼叫

实现悬浮窗

高级功能

Event

Config

客户端 API

用户登录（或重新登录、自动登录）您的应用后，您必须立即调用此方法。

# API


# ZegoUIKitPrebuiltCallInvitationService



## initWithAppID

用户登录（或重新登录、自动登录）您的应用后，您必须立即调用此方法。

#### 函数原型：

```swift
/// 初始化通话服务
/// - 参数:
///   - appID: 您的 appID
///   - appSign: 您的 appSign
///   - userID: 用户唯一标识
///   - userName: 用户名
///   - config: 通话邀请个性化配置
public func initWithAppID(_ appID: UInt32, 
                           appSign: String,
                           userID: String, 
                           userName: String, 
                           config: ZegoUIKitPrebuiltCallInvitationConfig)
```



## unInit

应与 `initWithAppID` API成对使用。

函数原型：

```swift 
/// 反初始化通话服务
public func unInit()
```



## getPrebuiltCallVC

您可以通过此接口访问通话页面控制器

函数原型：

```swift
/// 获取通话页面控制器
/// - Returns: ZegoUIKitPrebuiltCallVC
public func getPrebuiltCallVC() -> ZegoUIKitPrebuiltCallVC?
```



## setRemoteNotificationsDeviceToken

如果您想使用离线呼叫邀请，您必须调用此接口来设置当前设备的 token

函数原型：

```swift
/// 设置要推送离线的设备Token
/// - 参数:  
/// - deviceToken: 设备token
public static func setRemoteNotificationsDeviceToken(_ deviceToken: Data)
```



## endCall

您可以通过调用此接口来结束当前通话

函数原型：

```swift
/// 结束通话
public func endCall()
```
---


## setAudioOutputToSpeaker

您可以通过调用此接将音频路由到扬声器。

函数原型：

```swift
/// 设置音频路由到扬声器。
public func setAudioOutputToSpeaker(outputToSpeaker: Bool)
```
---


## getAudioRouteType

您可以通过调用此接口来获取当前音频路由。

函数原型：

```swift
/// 获取当前音频路由。
public func getAudioRouteType() -> ZegoUIKitAudioOutputDevice
```
---


# ZegoUIKitPrebuiltCallVC



## addButtonToBottomMenuBar

您可以通过调用此接口将自定义按钮添加到底部栏

函数原型：

```swift
public func addButtonToBottomMenuBar(_ button: UIButton)
```



## addButtonToTopMenuBar

您可以通过调用此接口将自定义按钮添加到顶部栏

函数原型：

```swift
public func addButtonToTopMenuBar(_ button: UIButton)
```



## finish

您可以通过调用此方法来结束当前通话。

函数原型：

```swift
public func finish()
```
