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

Debug 工具介绍

为提升接入和调试效率，点播 SDK 提供 Debug 工具。支持查看播放日志、视频信息和初始化信息。您可以在接入的过程中，直观方便的观察 SDK 相关信息。

使用说明

如下图所示，Debug 工具包含播放日志、视频信息、初始化信息 3 个不同的页签。具体信息请见附录。

前提条件

您已接入点播 SDK 1.32.1.1 或以上版本。点播 SDK 版本号详见发布历史。

注意事项

App 发布前，务必检查确认不要将 Debug 工具带到线上。

接入步骤

Debug 工具的接入步骤为：

1. 添加依赖。
2. 设置显示布局。
3. 释放。

详细代码示例如下：

// 导入头文件
#import <TTSDK/TTVideoEngine+DebugTool.h>

// 添加展示 debug 工具
- (void)showDebugTool {

// 强烈建议只在 Debug 模式下添加 debug 工具
#ifdef DEBUG
    CGFloat topCap = 70;
    CGFloat width = CGRectGetWidth(self.view.bounds);
    CGFloat height = CGRectGetHeight(self.view.bounds) - 100;
    [TTVideoEngine showDebugTool:self.view inRect:CGRectMake(0, topCap, width, height)];
#endif
}

// 不使用时，移除 debug 工具
- (void)removeDebugTool {
#ifdef DEBUG
    [TTVideoEngine removeDebugTool];
#endif
}

API 介绍

/// 当前 debug 工具是否正在展示，可以用来处理页面展示逻辑
+ (BOOL)debugToolIsShowing;
 
/// 添加展示 debug 工具到 containerView，debug 工具页面撑满containerView展示
/// Debug 工具为单例实现 containerView 推荐设置为 keywindow 或 设置为场景的 rootView
/// 该api没有暴露设置 engine 的实例参数，播放器内部会把当前正式播放的 Engine 实例自动添加到 Debug 工具中，不需要业务在频繁的设置engine实例
/// 播放器内部添加 engine 给 debug 工具的时机：调用 play 开始播放，播放状态变化等几个时机
/// 该 api 适合短视频（抖音）、中视频（西瓜）频繁切换播放场景
+ (void)showDebugTool:(UIView *)containerView;
 
/// 添加展示 debug 工具到 containerView，debug 工具页面撑满containerView展示
/// Debug 工具为单例实现 containerView 推荐设置为 keywindow 或 设置为场景的rootView
/// 该 api 没有暴露设置 engine 的实例参数，播放器内部会把当前正式播放的 Engine 实例自动添加到 Debug 工具中，不需要业务在频繁的设置engine实例
/// 播放器内部添加 engine 给 debug 工具的时机：调用 play 开始播放，播放状态变化等几个时机
/// 该 api 适合短视频（抖音）、中视频（西瓜）频繁切换播放场景
/// rect 为 debugView 在 containerView 中的 frame，例如可以通过设置 rect 适配上下安全区域
+ (void)showDebugTool:(UIView *)containerView inRect:(CGRect)rect;
 
/// 添加展示 debug 工具到 containerView，debug 工具页面撑满 containerView 展示
/// Debug 工具为单例实现 containerView 推荐设置为 keywindow 或设置为场景的 rootView
/// 该 api 暴露设置 engine 的实例参数，可以设置 debug 工具初始engine，当切换播放 debug 工具内部自动将正在播放的 engine 实例设置给degbug工具
/// rect 为 debugView 在 containerView 中的 frame，例如可以通过设置 rect 适配上下安全区域
+ (void)showDebugTool:(UIView *)containerView currentVideoEngine:(TTVideoEngine *)currentVideoEngine inRect:(CGRect)rect;
 
/// 移除 debug 工具
+ (void)removeDebugTool;