logo
当前页

API

ZegoUIKitPrebuiltCallInvitationService

initWithAppID

用户登录(或重新登录、自动登录)您的应用后,您必须立即调用此方法。

函数原型:

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

unInit

应与 initWithAppID API成对使用。

函数原型:

Untitled
/// 反初始化通话服务
public func unInit()
1
Copied!

getPrebuiltCallVC

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

函数原型:

Untitled
/// 获取通话页面控制器
/// - Returns: ZegoUIKitPrebuiltCallVC
public func getPrebuiltCallVC() -> ZegoUIKitPrebuiltCallVC?
1
Copied!

setRemoteNotificationsDeviceToken

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

函数原型:

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

endCall

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

函数原型:

Untitled
/// 结束通话
public func endCall()
1
Copied!

sendInRoomCommand

当用户加入房间后,可调用此接口在房间内发送自定义信令,信令最大长度为 1024 字节。

房间内其他用户可以通过调用 onIMRecvCustomCommand 来监听接收这个信令,详情请参考 Event 文档的 onIMRecvCustomCommand

当 toUserList为 [] 时,SDK 会将自定义信令发送给房间内的所有用户。

函数原型:

Untitled
func sendInRoomCommand(_ command: String, toUserIDs: [String], callback: ZegoSendInRoomCommandCallback?)
1
Copied!

setAudioOutputToSpeaker

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

函数原型:

Untitled
/// 设置音频路由到扬声器。
public func setAudioOutputToSpeaker(outputToSpeaker: Bool)
1
Copied!

getAudioRouteType

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

函数原型:

Untitled
/// 获取当前音频路由。
public func getAudioRouteType() -> ZegoUIKitAudioOutputDevice
1
Copied!

ZegoUIKitPrebuiltCallVC

addButtonToBottomMenuBar

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

函数原型:

Untitled
public func addButtonToBottomMenuBar(_ button: UIButton)
1
Copied!

addButtonToTopMenuBar

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

函数原型:

Untitled
public func addButtonToTopMenuBar(_ button: UIButton)
1
Copied!

finish

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

函数原型:

Untitled
public func finish()
1
Copied!

Previous

实现悬浮窗

Next

Event