调试与配置

功能简介

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

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

示例源码下载

请参考 下载示例源码 获取源码。

相关源码请查看 “/ZegoExpressExample/Examples/DebugAndConfig/Setting” 目录下的文件。

前提条件

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

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

使用步骤

设置日志属性

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

以设置日志存储路径为 “/Users/zego/Log/log.txt”，单个日志文件大小上限为 5 MB 为例：

ZegoLogConfig logConfig;
// 设置日志存储路径
logConfig.logPath = "/Users/zego/Log/log.txt";
// 设置单个日志文件大小上限
logConfig.logSize = 5242880L;
ZegoExpressSDK::setLogConfig(logConfig);

ZegoLogConfig logConfig;
// 设置日志存储路径
logConfig.logPath = "/Users/zego/Log/log.txt";
// 设置单个日志文件大小上限
logConfig.logSize = 5242880L;
ZegoExpressSDK::setLogConfig(logConfig);

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

struct ZegoLogConfig
{
    // 日志文件保存路径
    std::string logPath;

    // 日志文件大小上限 (Bytes)，默认为 5 MB (5 * 1024 * 1024 Bytes)
    unsigned long long logSize;

    ZegoLogConfig(){
        logSize = 5 * 1024 * 1024;
    }
};

struct ZegoLogConfig
{
    // 日志文件保存路径
    std::string logPath;

    // 日志文件大小上限 (Bytes)，默认为 5 MB (5 * 1024 * 1024 Bytes)
    unsigned long long logSize;

    ZegoLogConfig(){
        logSize = 5 * 1024 * 1024;
    }
};

创建引擎

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

如果需要注册回调代理，可将实现了 IZegoEventHandler 的对象传入参数 “eventHandler”。如果不需要注册回调代理，可将 “null” 传入参数 “eventHandler”。创建引擎后仍需要注册回调时，可通过调用 setEventHandler 接口设置回调代理。

// 定义 SDK 引擎对象
IZegoExpressEngine *engine = nullptr;

ZegoEngineProfile profile;
// AppID 和 AppSign 由 ZEGO 分配给各 App；其中，为了安全考虑，建议将 AppSign 存储在 App 的业务后台，需要使用时从后台获取
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_DEFAULT;
// 创建引擎实例
engine = ZegoExpressSDK::createEngine(profile, nullptr);

// 定义 SDK 引擎对象
IZegoExpressEngine *engine = nullptr;

ZegoEngineProfile profile;
// AppID 和 AppSign 由 ZEGO 分配给各 App；其中，为了安全考虑，建议将 AppSign 存储在 App 的业务后台，需要使用时从后台获取
profile.appID = appID;
profile.appSign = appSign;
profile.scenario = ZegoScenario::ZEGO_SCENARIO_DEFAULT;
// 创建引擎实例
engine = ZegoExpressSDK::createEngine(profile, nullptr);

（可选）开启调试助手

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

engine->enableDebugAssistant(true);

engine->enableDebugAssistant(true);

获取 SDK 版本号

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

engine->getVersion();

engine->getVersion();

相关文档

如何设置和获取 SDK 的日志、堆栈信息？