文档中心
互动视频
快速开始
初始化

初始化

更新时间：2023-09-15 18:30

1 功能简介

集成 SDK 完成后，要想使用 SDK 的功能，还需要对 SDK 进行初始化操作。

2 使用步骤

2.1 申请 AppID 与 AppSign

请在 ZEGO 控制台申请 SDK 初始化需要的 AppID 和 AppSign，获取 AppID 和 AppSign 指引。

2.2 导入 SDK 头文件

首先，导入头文件：

#import <ZegoLiveRoom/ZegoLiveRoom.h>

2.3 设置测试环境

针对 2021-11-16 及之前在 ZEGO 控制台创建的项目：
- 从控制台申请的 AppID 和 AppSign 等信息默认是测试环境，需要在初始化 SDK 前设置测试环境，否则 SDK 会初始化失败。应用正式上线前，请向 ZEGO 商务人员申请开启正式环境。
- setUseTestEnv 接口中的 “useTestEnv” 参数设置为 “true” 时表示使用测试环境；为 “false” 时表示使用正式环境。
针对 2021-11-16 之后在 ZEGO 控制台创建的项目：
- 控制台分配的 AppID 和 AppSign 等信息都为正式环境。
- setUseTestEnv 接口中的 “useTestEnv” 参数取值必须修改为 “false”，表示使用正式环境。

[ZegoLiveRoomApi setUseTestEnv:true];

注意：上线前需切换为正式环境运营。

2.4 初始化 SDK

使用 AppID 与 AppSign 初始化 SDK。

// 创建单例对象，SDK的引擎对象是单例模式
ZegoLiveRoomApi *api = [[ZegoLiveRoomApi alloc] initWithAppID:appID appSignature:appSign completionBlock:^(int errorCode){
    //init SDK completion
}];

初始化完成后，开发者即可调用 SDK 相关接口，实现所需功能。

除上述设置之外，用户可根据需求，判断是否需要在初始化 SDK 同时，开启其他功能。例如：外部渲染、外部采集、外部滤镜、软硬件编解码、开启流量控制等。

初始化 SDK 错误码

2.5 释放 SDK

开发者如果不需要再继续使用 SDK 可以将指针置空来释放 SDK。
注意：释放 SDK 后需要重新初始化 SDK 才能再次使用。

api = nil;

3 API 参考列表

方法	描述
- initWithAppID:appSignature:completionBlock:	初始化 SDK
+ setUseTestEnv:	测试环境开关
+ setVerbose:	打开调试信息开关

4 相关文档

完成了初始化 SDK 的操作后，可以使用 ZEGO SDK 依次完成如下功能来实现基础的通话或者直播。