使用手册

1 产品简介

棱镜是即构为开发者提供的音视频通话质量跟踪，故障定位，用户体验追溯的产品模块。其配合 SDK 的相关质量接口，形成一套辅助客户从多维度定位分析流质量数据，聚焦问题范围，促进用户体验优化的成熟解决方案。

2 功能介绍

棱镜由控制台交互界面、后台请求查询接口和SDK 质量回调接口配套组成：

在控制台上，流质量数据由流端到端维度、用户维度、房间维度组合呈现。

注意：仅限于从即构 UDP 服务器推拉流且使用新版 SDK 的用户，才可查询相关质量数据。

2.1 检索页

1. 支持以流 ID、用户 ID、房间 ID 检索近两周的相关流信息；
2. 支持检索正在进行中的连麦通话（存在两分钟上报延迟）；
3. 支持 URL 拼接检索 https://console.zego.im/prism?app=xxx&roomId=xxx&start=xxx&end=xxx

URL 的 query 参数说明：

其中 roomId、userId、stream 三个参数必传一个。

2.2 从流端到端维度查询数据页

1. 支持查看单条流在从推流端到拉流端的质量情况；
2. 支持切换查看不同用户的拉流情况（单条流可能存在多个用户拉流）；
3. 支持查看用户基本信息：用户 ID、SDK 版本、系统/机型、地区、运营商/网络类型；
4. 支持以 dashboard 观察以下几个流质量指标：

5. 支持以 dashboard 观察以下几个用户设备性能指标：

2.3 从用户维度查询数据页

1. 支持查看某用户基本信息：用户 ID、SDK 版本、系统/机型、地区、运营商/网络类型；
2. 支持查看某用户在房间内的推流情况（用户可能多次进房产生多条推流记录）；
3. 支持查看某用户在房间内的拉流情况（用户可能同时有多条拉流记录）。

2.4 从房间维度查询数据页

1. 支持查看单个房间的所有用户及基本信息；
2. 支持对有拉流的用户进行流质量对比，可观察用户的接收码率（视频/音频），接收帧率（视频/音频），卡顿。

3 棱镜开放API

支持在 SDK 集成时，获取相关质量回调，以供用户监测此次通话/直播的音视频质量，详细操作步骤请查看 应用端-监测推拉流质量。

4 其它说明

棱镜默认可查询推流数据，如果需要查询更多拉流数据及功能开放，请联系我们：400-166-8807。