CDN加速

文档中心 直播分发 直播相关信息查询 直播流推流信息查询API

直播流推流信息查询API

更新时间:2020-04-27 14:06:23

一.功能简介

  互动直播业务中,直播流由主播主动推送至CDN平台,而主播推流的码率、帧率、丢帧率等一定程度上决定了主播推流的质量。该信息可以从推流器端进行获取也可以由服务器端进行获取,推流器端获取的信息相对于客户而言是最为准确的。但游戏直播客户通常支持第三方推流器,客户无法直接的获取到相应信息。
  目前我司提供相应API接口给客户,从CDN节点计算主播的推流码率、帧率、丢帧率等信息,以供客户监测主播推流的质量。

二. 使用说明

  网宿提供相应的API 接口给客户。具体API 举例如下:
  http://qualiter.wscdns.com/api/frameRate.jsp?n=XXX&r=XXX&k=XXX&u=XXXX&t=XXX&g=XXX&channel=XXX
  其中HTTP请求的URL中的?后带七个参数:n、r、k、u必填;t、g、channel选填。
  1) n:默认设置为Protal平台帐号名;
  2) r:唯一随机字符串,限制最大为10位,推荐使用时间戳;
  3) u:所需查询的推流域名
  4) k:md5验证值。
   MD5 计算方式为:
   k = md5(r+key),即 r 字符串加上key字符串,得到一个新的字符串,再对该字符串做MD5 计算出新值为k 的值。注:key 可向对应客服获取。
  例如:
   1、 申请获取到key=012f37a3f2952
   2、 随机生成字符串r=1409284800
   3、 合并生成字符串new=1409284800012f37a3f2952
   4、 使用MD5 计算new 得到 k值b9fed80be752551834eec3e52fa94115

  5) t:时间,格式为:t=20160527152300,此参数选填,当参数为空时,默认返回服务器响应请求时间前5min数据。
  注:该接口数据粒度为1分钟1次,因此,建议调用频率为1分钟一次即可。
  6) g:查询间隔,格式为g=10,此参数选填,有10s 和60s 可选,当参数为空时,默认为60s。
  注:当g为10时,查询距离时间t最近的整10秒点数据;当g为60时,查询距离时间t最近的整分钟点数据。
  7) channel: 频道地址,此参数选填。当指定频道,则返回指定频道的查询信息;当参数为空时,默认返回域名下所有频道信息。
   例如:www.wstest.com/live/streamname
   客户以上述格式发送HTTP 请求调用该接口时,接口将返回以下信息:
   1) deployaddress:主播流推送的CDN节点IP;
   2) inaddress:主播出口ip;
   3) streamname:主播流名;
   4) fps:主播当前编码帧率;
   5) lfr:主播当前丢帧率;
   6) inbandwidth:主播当前码率;
   7) retcode:数据条数,即查询域名下直播流数;
   8) rettime:返回的数据的时间;

  结果以JSON格式返回,返回格式如下:

{
    "dataValue": [
        {
            "deployaddress": "XXX",
            "fps": XXX,
            "inaddress": "XXX",
            "inbandwidth": XXX,
            "lfr": "XXX",
            "streamname": "XXX"
        }
    ],
    "retcode": XXX,
    "rettime": "XXX"
} 

三. 应用场景

  所有互动直播业务,直播平台需要了解主播推流的帧率、丢帧率、码率信息。

四.注意事项

  1) API接口中两个参数之间用与号(&)隔开;
  2) 请不要在问号(?)后面带空格等不符合HTTP协议的字符,如果在URL或目录名中使用这些字符,请务必使用转义符(比如,空格的转义符为%20);
  3) 由于与号(&)是参数的分隔符,分号(;)是不同URL/目录名的分隔符,带这2个字符的URL将不能正常推送。
  4) 该调用方式对大小写敏感,在发送HTTP请求方式调用该接口时,请注意相应的大小写要严格符合要求。
  5) 接口调用限制5分钟100次