实时语音
  • iOS
  • Android : Java
  • Windows
  • 概述
  • 限制说明
  • SDK 下载
  • 快速开始
  • 进阶功能
  • API 文档
  • 常见错误码
  • 语音通话
  • 语音直播
  • 游戏语音
  • 文档中心
  • 实时语音
  • 快速开始
  • 初始化

初始化

更新时间:2023-09-15 18:35

1 简介

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

建议开发者在初始化 App 的同时,初始化 SDK。 注意:在调用 SDK 的其它功能之前必须先初始化 SDK,SDK 的初始化请查看 2.2 初始化

2 步骤

2.1 申请 AppID 与 AppSign

下载的 Demo 源码中缺少 SDK 初始化必须的 AppID 和 AppSign,请提前在 ZEGO 控制台 获取。如果不填写正确的 AppID 和 AppSign,源码无法正常跑起来。

2.2 初始化

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

  1. 设置 userID 和 userName

  2. 根据获取的 AppID 和 AppSign 初始化 ZegoAudioRoom 对象

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

  1. 设置测试环境。切换为测试环境后,开发者会使用由 Zego 提供的测试环境,注意上线前需切换为正式环境运营。

  2. 打开调试信息开关,调试开关开启后,SDK 会把网络请求、错误消息等输出到 IDE 的日志窗口,方便开发者调试。注意上线前关闭。

请注意:

  1. userID 和 userName 来自于 App 自定义的账号系统。
  2. AppID 和 AppSign 由 Zego 分配给各 App。为了安全考虑,建议将 AppSign 存储在 App 的业务后台,使用时从后台获取。

代码片段示例如下:

@Override
public void onCreate() {
    super.onCreate();
    ...
    // 测试环境开关 (可选设置)
    ZegoAudioRoom.setUseTestEnv(true);

    // 根据当前运行模式是否打开调试信息,仅供参考 (可选设置)
    ZegoAudioRoom.setVerbose(BuildConfig.DEBUG);

    // 设置 UserID 和 UserName。userID 和 userName 来自于 App 自定义的账号系统 (必须设置)
    ZegoAudioRoom.setUser(userID, userName);

    g_ZegoApi = new ZegoAudioRoom();
        // 初始化 ZegoAudioRoom 对象。AppID 和 AppSign 由 Zego 分配给各 App。其中,为了安全考虑,建议将 AppSign 存储在 App 的业务后台,需要使用时从后台获取 (必须调用)
    g_ZegoApi.initWithAppId(appID, appSignature, this);
    ...
}

2.3 完成 SDK 初始化

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

2.4 集成日志上传

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

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

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

ZegoLiveRoom.java

/**
 上报日志

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

API 调用示例代码如下:

ZegoLiveRoom.uploadLog();
本篇目录