接入 Debug 工具

本文包含 Debug 工具的介绍和接入说明等内容。

Debug 工具介绍

为提升接入和调试效率，点播 SDK 提供 Debug 工具，方便您在接入点播 SDK 的过程中更为直观地查看 SDK 相关信息。如下图所示，Debug 工具包含播放日志、视频信息、初始化信息 3 个不同的页签。具体信息介绍请见附录。

前提条件

您已接入点播 SDK，且版本 >= 1.32.1.5。点播 SDK 版本号详见发布历史。

注意事项

• App 发布前，务必检查确认不要将 Debug 工具带到线上，需要去除 ttvideoengine-debugtool 库依赖。
• 单击保存信息按钮后，Debug 信息会保存在 /data/user/0/包名/files/engine_debug_info/debug_info.log 文件中。

接入步骤

1. 添加依赖

使用 Debug 工具进行调试时，需要添加依赖，实现的代码示例如下所示。

dependencies {
    ...
    debugImplementation "com.bytedanceapi:ttvideoengine-debugtool:0.3.0.1" 
}

2. 设置显示布局

设置显示布局，需要在调用 engine 播放之前。

1. 您可根据自身业务需求，自定义创建 Debug 信息显示布局，可以通过 setContainerView 设置给 Debug 工具。
2. 设置布局完成后，Debug 工具会监听哪个 Engine 实例调用了 play，之后将相关信息显示到布局。

上述实现设置显示布局的代码示例如下所示。

FrameLayout debugLayer = findViewById(R.id.fl_debugtool);
DebugTool.setContainerView(debugLayer);

3. 释放

完成 Debug 工具使用时，您可调用 release() 方法释放资源。实现的代码示例如下所示。

DebugTool.release();

API 介绍

public class DebugTool { 

    // 添加展示 debug 信息的布局，debug 信息页面撑满 containerView
    // 需要在调用 Engine 播放之前设置，
    // 设置布局后，Debug 工具会监听哪个 Engine 实例调用了 play，并将相关信息显示到布局。
    public static void setContainerView(ViewGroup containerView);
    
    // 完成 Debug 工具使用时，您可调用release()方法释放资源
    public static void release();
    
    //  通常情况下 Debug 工具会自动监听哪个 Engine 实例调用了 play，显示该 Engine 的信息；
    // 多个 Engine 实例同时存在时，您可主动设置 Engine 实例选择显示哪个 Engine 实例的信息。
    public static void setTTVideoEngine(TTVideoEngineInterface engine);

}

附录

播放日志

视频信息

初始化信息