初始化

下载pdf
更新时间:2019-04-29 16:06

1 简介

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

建议开发者在初始化 App 的同时,初始化 SDK。

2 步骤

2.1 导入 SDK 头文件

首先,在 AppDelegate.m 中导入头文件:

#import <ZegoAudioRoom/ZegoAudioRoom.h>

然后,在如下系统方法中进行初始化操作。具体的操作步骤参考 2.2 小节。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 

2.2 初始化

初始化 SDK 时必须要做的事情:

  1. 设置 userID 和 userName。
  2. 根据 AppID 和 AppSign 初始化 ZegoAudioRoomApi 对象。

除此之外,建议在初始化前做的事情:

  1. 设置测试环境。切换为测试环境后,开发者会使用由 Zego 提供的测试环境,注意上线前需切换为正式环境运营。
  2. 打开调试信息开关,调试开关开启后,SDK 会把网络请求、错误消息等输出到 IDE 的日志窗口,方便开发者调试。注意上线前关闭。

代码片段示例如下:

// 测试环境开关
[ZegoAudioRoomApi setUseTestEnv:YES];

// 通过宏定义选择是否打开调试信息,仅供参考
#ifdef DEBUG

// 调试信息开关
[ZegoAudioRoomApi setVerbose:YES];

#endif

// 设置 UserID 和 UserName。userID 和 userName 来自于 App 自定义的账号系统
[ZegoAudioRoomApi setUserID:userID userName:userName];

// 初始化 ZegoAudioRoomApi 对象。AppID 和 AppSign 由 Zego 分配给各 App。其中,为了安全考虑,建议将 AppSign 存储在 App 的业务后台,需要使用时从后台获取
g_ZegoApi = [[ZegoAudioRoomApi alloc] initWithAppID:appID appSignature:appSign];

2.3 完成初始化

初始化完成后,开发者即可调用 SDK 相关接口,实现对应功能。

2.4 集成日志上传

ZEGO SDK 不会自动上传日志,为了便于人工定位问题,我们建议开发者将 ZEGO SDK 的日志上传功能,集成在 App 的合适位置。

请注意,建议开发者在 App 中引导用户手动触发日志上传。不建议 App 频繁自动上传日志

ZEGO SDK 提供如下 API 上传日志:

ZegoLiveRoomApi.h

/**
 上报日志

 @discussion 上传日志到后台便于分析问题
 */
+ (void)uploadLog;

API 调用示例代码如下:

[ZegoLiveRoomApi uploadLog];