节目超规格检测 - NovaCloud-CN

通过此接口检查节目下发给需要的设备会不会出现超规格情况

图片的超规格的标准是宽度不大于2160px,高度不大于4096,并且图片面积不能超过2160x4096

请求参数

Header 参数

AppKey

string

接入键

必需

默认值:

Nonce

string

必需

随机字符串（8~64个字符，仅限数字或英文字母）

CurTime

string

必需

当前 UTC 时间戳

CheckSum

string

请求签名

必需

Body 参数application/json

playerIds

array[string]

必需

需要处理的播放器ID集合,最多支持100个播放器同时处理

pages

array [object {3}]

必需

需要播放的页面内容集合

pageId

integer

必需

页面对应的id，需要保证整个协议中唯一

name

string

页面名称

必需

widgets

array [object {14}]

页面上的组件

必需

示例

{
  "playerIds": [
    "f6535700b9613349b915135919a8dfcd",
    "fdddddddddd13349b915135919a8dfce"
  ],
  "pages": [
    {
      "pageId": 1,
      "name": "页面1",
      "widgets": [
        {
          "widgetId": 1,
          "type": "PICTURE",
          "size": 25943,
          "md5": "8330dcaa949ceeafa54a66e8ad623300",
          "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
          "width": "3840",
          "height": "2160"
        },
        {
          "widgetId": 2,
          "type": "PICTURE",
          "size": 25943,
          "md5": "8330dcaa949ceeafa54a66e8ad623300",
          "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
          "width": "3840",
          "height": "2160"
        }
      ]
    },
    {
      "pageId": 2,
      "name": "新页面2",
      "widgets": [
        {
          "widgetId": 3,
          "type": "VIDEO",
          "size": 1227710,
          "md5": "f5b0f315800cb4befb89b5dff42f1e34",
          "duration": 5000,
          "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
          "width": "3840",
          "height": "2160",
          "fps": "60",
          "byteRate": "18003",
          "codec": "h264",
          "postfix": "mp4"
        },
        {
          "widgetId": 4,
          "type": "VIDEO",
          "size": 1227710,
          "md5": "f5b0f315800cb4befb89b5dff42f1e34",
          "duration": 5000,
          "url": "http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
          "width": "3840",
          "height": "2160",
          "fps": "60",
          "byteRate": "18003",
          "codec": "h264",
          "postfix": "mp4"
        }
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-cn.vnnox.com/v2/player/program/over-specification-check' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "playerIds":[
      "f6535700b9613349b915135919a8dfcd",
      "fdddddddddd13349b915135919a8dfce"
  ],
  "pages":[
      {
          "pageId":1,
          "name":"页面1",
          "widgets":[
              {
                  "widgetId":1,
                  "type":"PICTURE",
                  "size":25943,
                  "md5":"8330dcaa949ceeafa54a66e8ad623300",
                  "url":"http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
                  "width":"3840",
                  "height":"2160"
              },
              {
                  "widgetId":2,
                  "type":"PICTURE",
                  "size":25943,
                  "md5":"8330dcaa949ceeafa54a66e8ad623300",
                  "url":"http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/test.jpg",
                  "width":"3840",
                  "height":"2160"
              }
          ]
      },
      {
          "pageId":2,
          "name":"新页面2",
          "widgets":[
              {
                  "widgetId":3,
                  "type":"VIDEO",
                  "size":1227710,
                  "md5":"f5b0f315800cb4befb89b5dff42f1e34",
                  "duration":5000,
                  "url":"http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
                  "width":"3840",
                  "height":"2160",
                  "fps":"60",
                  "byteRate":"18003",
                  "codec":"h264",
                  "postfix":"mp4"
              },
              {
                  "widgetId":4,
                  "type":"VIDEO",
                  "size":1227710,
                  "md5":"f5b0f315800cb4befb89b5dff42f1e34",
                  "duration":5000,
                  "url":"http://vnnox-public.oss-cn-qingdao.aliyuncs.com/myf/nova2019.mp4",
                  "width":"3840",
                  "height":"2160",
                  "fps":"60",
                  "byteRate":"18003",
                  "codec":"h264",
                  "postfix":"mp4"
              }
          ]
      }
  ]
}'

返回响应

🟢200成功

application/json

Body

logid

integer

必需

status

integer

必需

data

array [object {4}]

必需

overSpec

boolean

必需

批次检测的超规格结果，true-超规格，false-没有超规格

playerIds

array[string]

必需

批次检查的播放器ID集合

overSpecType

integer

可选

返回信息协议中的”overSpecType”字段表示节目超规格的类型
1 表示节目中仅单个媒体超规格
2 表示节目中仅窗口数量超规格
3 表示节目规格媒体的数量超规格（路数超规格）
4 表示节目中同时存在
上述”1”、”2”、”3”类型超规格。

overSpecDetail

array [object {4}]

可选

当节目超规格后，此属性会返回那些内容超规格了，推荐的转码格式是什么

示例

{
  "logid": 1588056252560,
  "status": 0,
  "data": [
    {
      "overSpec": false,
      "playerIds": [
        "fdddddddddd13349b915135919a8dfce"
      ]
    },
    {
      "overSpec": true,
      "overSpecType": 1,
      "overSpecDetail": [
        {
          "pageId": 2,
          "widgetId": 3,
          "overSpecErrorCode": [
            -20,
            -21
          ],
          "recommend": {
            "width": "3840",
            "height": "2160",
            "postfix": "mp4",
            "fps": "30",
            "byteRate": "78.000000",
            "codec": "h264"
          }
        },
        {
          "pageId": 2,
          "widgetId": 4,
          "overSpecErrorCode": [
            -20,
            -21
          ],
          "recommend": {
            "width": "3840",
            "height": "2160",
            "postfix": "mp4",
            "fps": "30",
            "byteRate": "78.000000",
            "codec": "h264"
          }
        },
        {
          "pageId": 2,
          "widgetId": 5,
          "overSpecErrorCode": [
            10001
          ],
          "recommend": {
            "width": "2160",
            "height": "4096"
          }
        }
      ],
      "playerIds": [
        "f6535700b9613349b915135919a8dfcd"
      ]
    }
  ]
}