Program Over-specification Detection

1.This interface is used to check whether the program sent to the required devices will be any over-specification
2.The over-spec standard of the image is that the width is not more than 2160 px, the height is not more than 4096 px, and the image area cannot exceed 2160x4096

Request

Header Params

AppKey

string

required

Access key

Default:

Nonce

string

required

Random string (8-64 characters, only numbers or letters)

CurTime

string

required

The current UTC timestamp

CheckSum

string

required

Request signature

Body Params application/json

playerIds

array[string]

required

pages

array [object {3}]

required

pageId

integer

required

name

string

required

widgets

array [object {13}]

required

Example

{
  "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"
        }
      ]
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.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"
              }
          ]
      }
  ]
}'

Responses

🟢200OK

application/json

Body

logid

integer

required

status

integer

required

data

array [object {4}]

required

overSpec

boolean

required

The over-specification result of the batch test is true- over-specification, false- no over-specification

playerIds

array[string]

required

overSpecType

integer

optional

The "overSpecType" field in the return information protocol indicates the type of program superspecification

1 indicates that there is only a single media in the program

2 indicates that the number of Windows in the program exceeds the upper limit

3 Indicates the number of program specifications media exceeds specifications (number of channels exceeds specifications)

4 indicates that the program exists simultaneously

The values of type 1, 2, and 3 are out of specification.

overSpecDetail

array [object {4}]

optional

When the program is out of spec, this property returns what content is out of spec. What is the recommended transcoding format

Example

{
  "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"
      ]
    }
  ]
}