查询推拉流质量

下载pdf
更新时间:2019-09-27 10:09

1 功能简介

ZEGO 后台服务支持查询连续 1 周的推拉流质量数据,Android 设备的系统 CPU、App CPU使用率,系统内存、App 内存的使用量以及设备内存的总大小。

2 查询推流/拉流质量

推流质量指标

指标项 类型 说明
audio_bitrate Int 音频发送码率(Kbps)
video_bitrate Int 视频发送码率(Kbps)
video_capture_fps Int 视频采集帧率(fps)
audio_network_fps Int 音频发送帧率(fps)
video_network_fps Int 视频发送帧率(fps)
uplink_plr Int 音视频上行丢包率(%)
rtt Int 音视频发送 rtt(ms)
sample_time_window Int 采样窗口时长(ms)

拉流质量指标

指标项 类型 说明
audio_bitrate Int 音频接收码率(Kbps)
video_bitrate Int 视频接收码率(Kbps)
video_network_fps Int 视频接收帧率(fps)
downlink_plr Int 音视频下行丢包率(%)
peer_to_peer_plr Int 推流端到拉流端的音视频丢包率(%)
peer_to_peer_delay Int 推流端到拉流端的音视频传输延迟(ms)
audio_network_fps Int 音频接收帧率(fps)
audio_break_duration Int 音频卡顿时长(ms),参考 sample_time_window
video_break_duration Int 视频卡顿时长(ms),参考 sample_time_window
sample_time_window Int 采样窗口时长(ms)

2.1 请求接口说明

http请求方式:POST/GET,需使用https

查询推流质量:https://websj.zego.im/v1/stream/publish-quality

查询拉流质量:https://websj.zego.im/v1/stream/play-quality

频率限制:60次/分钟

校验签名方式:http://websj.zego.im/doc/sign

2.2 请求参数说明

参数名 是否必须 类型 说明
date String 查询日期,格式 YYYY-MM-DD 范围为7天前至当天
app Int AppID
stream String 流 ID,流 ID 和用户 ID 不能同时为空
user_id String 用户 ID,流 ID 和用户 ID 不能同时为空
start_time String 开始时间,格式 14:53:16 默认 00:00:00
end_time String 截止时间,格式 14:53:16 默认 23:59:59

2.3 返回示例说明

{
    "code":200,
    "message":"OK",
    "data":{
        "items":[
            {
                "stat_time":1560478268,
                "time_consumed":56,
                "app":1739272706,
                "stream":"s-1560242676237-1560477947124",
                "user_id":"test_pb_user101",
                "client_ip":"183.17.230.106",
                "metrics":[
                    {
                        "audio_bitrate":53,
                        ...
                    }
                    ...
                ]
            }
        ],
        "_meta":{
            "totalCount":22,
            "pageCount":22,
            "currentPage":1,
            "perPage":1
        }
    },
    "RequestId":"268d3c22-13bc-468d-8167-dd8bb52f08df"
}

其中 items 为结果列表,每一项字段说明如下:

参数名 类型 说明
stat_time Int 统计时间戳,单位:s
time_consumed Int 统计时长,单位:s
app Int AppID
stream String 流 ID
user_id String 用户 ID
client_ip String 用户 IP
metrics Array 指标集合,参见推流/拉流质量指标项含义

注意:

  1. time_consumed 采样耗时内可能多次采样,metrics 内有多组数据。
  2. 因 SDK 版本不同,指标项可能不同。

3 查询设备硬件信息

设备硬件信息指标

指标项 类型 说明
sys_cpu_used Int 系统 CPU 使用率,百分比
app_cpu_used Int App CPU 使用率,百分比
sys_mem_used Int 系统内存使用量,单位:M
app_mem_used Int App 内存使用量,单位:M

3.1 请求接口说明

http请求方式:POST/GET,需使用https

查询设备硬件信息:https://websj.zego.im/v1/stream/hardware-quality

频率限制:60次/分钟

校验签名方式:http://websj.zego.im/doc/sign

3.2 请求参数说明

参数名 是否必须 类型 说明
date String 查询日期,格式 YYYY-MM-DD 范围为7天前至当天
app Int AppID
user_id String 用户 ID
start_time String 开始时间,格式 14:53:16 默认 00:00:00
end_time String 截止时间,格式 14:53:16 默认 23:59:59

3.3 返回示例说明

{
    "code":200,
    "message":"OK",
    "data":{
        "items":[
            {
                "stat_time":1560773749,
                "time_consumed":54,
                "app":1739272706,
                "user_id":"1544419812994",
                "client_ip":"121.35.103.239",
                "sys_mem_total":1512,
                "metrics":[
                    {
                        "app_cpu_used":0,
                        "app_mem_used":77,
                        "sys_cpu_used":0,
                        "sys_mem_used":1173
                    },
                    ...
                ]
            }
        ],
        "_meta":{
            "totalCount":11,
            "pageCount":11,
            "currentPage":1,
            "perPage":1
        }
    },
    "RequestId":"47fc305c-a9ac-48e7-a17e-7d0ca93460c0"
}

其中 items 为结果列表,每一项字段说明如下:

参数名 类型 说明
stat_time Int 统计时间戳,单位:s
time_consumed Int 统计时长,单位:s
app Int AppID
stream String 流 ID
user_id String 用户 ID
sys_mem_total Int 系统总的内存大小,单位:M
metrics Array 指标集合,参见设备硬件信息质量指标项含义

注意:

  1. time_consumed 采样耗时内可能多次采样,metrics 内有多组数据。
  2. 因 SDK 版本不同,指标项可能不同。
  3. 0 值项可能为设备还不支持。目前仅android7.0以下设备支持,其他平台或者其他版本暂不支持。