调试与配置

2023-11-20

功能简介

开发者在集成 SDK 时会遇到一些错误，SDK 会输出相关错误日志，开发者可以根据需要，配置日志输出路径和单个日志文件大小。

除此之外，SDK 支持调用接口查看当前版本。

前提条件

在使用日志相关功能之前，请确保：

已在项目中集成 ZEGO Express SDK，实现基本的实时音视频功能，详情请参考快速开始 - 集成和快速开始 - 实现流程。
已在 ZEGO 控制台创建项目，并申请有效的 AppID 和 AppSign，详情请参考控制台 - 项目信息。

使用步骤

设置日志属性

在创建引擎前，可通过调用 setLogConfig 接口设置日志属性。

下面将以设置日志存储路径为 “/data/user/0/包名/files”，单个日志文件大小上限为 5MB 为例进行说明：

// getApplicationSupportDirectory需要使用第三方库path_provider
var filesDir = await getApplicationSupportDirectory();
// 设置日志存储路径
String logPath = filesDir.absolute.path;
// 设置单个日志文件大小上限
int logSize = 5242880;

var logConfig = ZegoLogConfig(logPath, logSize);

ZegoExpressEngine.setLogConfig(logConfig);

// getApplicationSupportDirectory需要使用第三方库path_provider
var filesDir = await getApplicationSupportDirectory();
// 设置日志存储路径
String logPath = filesDir.absolute.path;
// 设置单个日志文件大小上限
int logSize = 5242880;

var logConfig = ZegoLogConfig(logPath, logSize);

ZegoExpressEngine.setLogConfig(logConfig);

其中，ZegoLogConfig 包含了日志相关设置（保存路径和文件大小上限），具体定义如下：

class ZegoLogConfig {
    // 日志文件保存路径
    String logPath;
    // 日志文件大小上限 (Bytes)，默认为 5MB (5 * 1024 * 1024 Bytes)
    int logSize;

    ZegoLogConfig(this.logPath, this.logSize);
}

class ZegoLogConfig {
    // 日志文件保存路径
    String logPath;
    // 日志文件大小上限 (Bytes)，默认为 5MB (5 * 1024 * 1024 Bytes)
    int logSize;

    ZegoLogConfig(this.logPath, this.logSize);
}

创建引擎

定义 SDK 引擎对象，调用 createEngineWithProfile 接口，将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”，创建引擎单例对象。

// 请通过官网注册获取，格式为 123456789L
int appID = appID;
// 64 个字符，请通过官网注册获取，格式为"0123456789012345678901234567890123456789012345678901234567890123"
String appSign = appSign;
// 通用场景接入
ZegoScenario scenario = ZegoScenario.GENERAL;

var profile = ZegoEngineProfile(appID, scenario, appSign: appSign);

// 创建引擎
ZegoExpressEngine.createEngineWithProfile(profile);

// 实时音视频 SDK 做纯音频场景时，可以关闭摄像头，这样将不会需要摄像头权限和推视频流
// ZegoExpressEngine.instance.enableCamera(false);

// 请通过官网注册获取，格式为 123456789L
int appID = appID;
// 64 个字符，请通过官网注册获取，格式为"0123456789012345678901234567890123456789012345678901234567890123"
String appSign = appSign;
// 通用场景接入
ZegoScenario scenario = ZegoScenario.GENERAL;

var profile = ZegoEngineProfile(appID, scenario, appSign: appSign);

// 创建引擎
ZegoExpressEngine.createEngineWithProfile(profile);

// 实时音视频 SDK 做纯音频场景时，可以关闭摄像头，这样将不会需要摄像头权限和推视频流
// ZegoExpressEngine.instance.enableCamera(false);

（可选）开启调试助手

建议在开发调试阶段调用 enableDebugAssistant 接口开启 SDK 的调试助手功能，当后续调用其他 SDK 的接口时，既能输出日志到控制台，同时在接口调用出错时还会弹窗提醒，方便开发者第一时间发现问题并及时修正。

注意

当开发完成，即将上线 App 前，请务必关闭此功能，以避免在线上环境发生潜藏错误时弹出 UI 弹窗。

ZegoExpressEngine.instance.enableDebugAssistant(true);

ZegoExpressEngine.instance.enableDebugAssistant(true);

获取 SDK 版本号

调用 getVersion 接口可获取 SDK 版本号。开发者可将 SDK 版本号信息作为 App 所使用的 Engine 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

说明

SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术支持进行定位，ZEGO 技术支持可能需要 Engine 的版本的信息来辅助定位问题。

ZegoExpressEngine.getVersion();

ZegoExpressEngine.getVersion();