Offline Export - NovaCloud-EN

1.Through this interface, you can export Nova playback protocol for offline programs
2.Support T card version 2.0.0 and above, vPlayer version 4.0.0 and above

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

programType

integer

required

Program type, 1- Normal program

planVersion

string

required

Protocol version: V1, V2; If the T card version is greater than 3.10.0.0601 or the V card version is greater than 4.1.1.0601, the V2 protocol is used when multiple lines of text are delivered

schedule

object

required

The time schedule of the whole program, if empty, will be played on a loop 24 hours a day; If both the program level schedule and page level schedule are set at the same time, the playback will be subject to the intersection of the schedule

startDate

string

required

Playback start date, such as: 2020-04-12

endDate

string

required

Playback end date, such as: 2020-04-12

plans

object

required

Detailed playback plan

pages

array [object {2}]

required

A collection of page content to be played

name

string

optional

Page name

widgets

array [object]

optional

Component array, specific reference: Program component catalog

Example

{
  "programType": 1,
  "planVersion": "V2",
  "schedule": {
    "startDate": "2020-04-11",
    "endDate": "2060-05-12",
    "plans": [
      {
        "weekDays": [
          0,
          1,
          2,
          3,
          4,
          5,
          6
        ],
        "startTime": "00:00",
        "endTime": "23:00"
      }
    ]
  },
  "pages": [
    {
      "name": "a-page",
      "widgets": [
        {
          "zIndex": 1,
          "type": "DRAWN_DIGITAL_CLOCK",
          "zone": "Asia/Shanghai",
          "gmt": "GMT+08:00",
          "regular": "$MM/$dd/$yyyy\n$E\n$N&#160;$hh:$mm:$ss",
          "weekTemplates": [
            "Sunday",
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
            "Saturday"
          ],
          "suffixTemplates": [
            "morning",
            "afternoon"
          ],
          "textColor": "#ff0000",
          "fontSize": 14,
          "fontFamily": [
            "Times",
            "Georia",
            "New York"
          ],
          "fontStyle": "Bold",
          "fontIsUnderline": false,
          "backgroundColor": "#00ff00",
          "shadowEnable": false,
          "shadowRadius": 10,
          "shadowDx": 2,
          "shadowDy": 2,
          "shadowColor": "#00ff00",
          "layout": {
            "x": "0%",
            "y": "0%",
            "width": "50%",
            "height": "50%"
          }
        },
        {
          "zIndex": 2,
          "type": "PICTURE",
          "size": 25943,
          "md5": "8330dcaa949ceeafa54a66e8ad623300",
          "duration": 5000,
          "url": "test.jpg",
          "layout": {
            "x": "50%",
            "y": "0%",
            "width": "50%",
            "height": "50%"
          },
          "inAnimation": {
            "type": "NONE",
            "duration": 1000
          }
        },
        {
          "zIndex": 3,
          "type": "VIDEO",
          "size": 1227710,
          "md5": "f5b0f315800cb4befb89b5dff42f1e34",
          "duration": 5000,
          "url": "nova2019.mp4",
          "fileName": "nova2019.mp4",
          "layout": {
            "x": "0%",
            "y": "50%",
            "width": "50%",
            "height": "50%"
          }
        },
        {
          "zIndex": 4,
          "type": "ARCH_TEXT",
          "displayType": "SCROLL",
          "backgroundColor": "#00000000",
          "scrollAttribute": {
            "animation": "MARQUEE_LEFT",
            "speed": 3,
            "isHeadTail": true
          },
          "duration": 5000,
          "lines": [
            {
              "textAttributes": [
                {
                  "content": "API",
                  "fontSize": 26,
                  "textColor": "#337FE5",
                  "isBold": true
                },
                {
                  "content": "some following content",
                  "fontSize": 16,
                  "textColor": "#FF0000",
                  "isBold": false
                }
              ]
            },
            {
              "textAttributes": [
                {
                  "content": "some main content",
                  "fontSize": 16,
                  "textColor": "#FF0000",
                  "isUnderline": false
                }
              ]
            }
          ],
          "layout": {
            "x": "50%",
            "y": "50%",
            "width": "50%",
            "height": "50%"
          }
        }
      ]
    }
  ]
}

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/offline-export' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"programType": 1,
	"planVersion": "V2",
	"schedule": {
		"startDate": "2020-04-11",
		"endDate": "2060-05-12",
		"plans": [
			{
				"weekDays": [
					0,
					1,
					2,
					3,
					4,
					5,
					6
				],
				"startTime": "00:00",
				"endTime": "23:00"
			}
		]
	},
	"pages": [
		{
			"name": "a-page",
			"widgets": [
				{
					"zIndex": 1,
					"type": "DRAWN_DIGITAL_CLOCK",
					"zone": "Asia/Shanghai",
					"gmt": "GMT+08:00",
					"regular": "$MM/$dd/$yyyy\n$E\n$N&#160;$hh:$mm:$ss",
					"weekTemplates": [
                        "Sunday",
                        "Monday",
                        "Tuesday",
                        "Wednesday",
                        "Thursday",
                        "Friday",
                        "Saturday"
					],
					"suffixTemplates": [
						"morning",
						"afternoon"
					],
					"textColor": "#ff0000",
					"fontSize": 14,
					"fontFamily": ["Times","Georia","New York"],
					"fontStyle": "Bold",
					"fontIsUnderline": false,
					"backgroundColor": "#00ff00",
					"shadowEnable": false,
					"shadowRadius": 10,
					"shadowDx": 2,
					"shadowDy": 2,
					"shadowColor": "#00ff00",
					"layout": {
						"x": "0%",
						"y": "0%",
						"width": "50%",
						"height": "50%"
					}
				},
				{
                    "zIndex": 2,
                    "type": "PICTURE",
                    "size": 25943,
                    "md5": "8330dcaa949ceeafa54a66e8ad623300",
                    "duration": 5000,
                    "url": "test.jpg",
                    "layout": {
                        "x": "50%",
                        "y": "0%",
                        "width": "50%",
                        "height": "50%"
                    },
                    "inAnimation": {
                        "type": "NONE",
                        "duration": 1000
                    }
                },
				{
                    "zIndex": 3,
                    "type": "VIDEO",
                    "size": 1227710,
                    "md5": "f5b0f315800cb4befb89b5dff42f1e34",
                    "duration": 5000,
                    "url": "nova2019.mp4",
                    "fileName": "nova2019.mp4",
                    "layout": {
                        "x": "0%",
                        "y": "50%",
                        "width": "50%",
                        "height": "50%"
                    }
                },
				{
                    "zIndex": 4,
                    "type": "ARCH_TEXT",
                    "displayType": "SCROLL",
                    "backgroundColor": "#00000000",
                    "scrollAttribute": {
                        "animation": "MARQUEE_LEFT",
                        "speed": 3,
                        "isHeadTail": true
                    },
                    "duration": 5000,
                    "lines": [
                        {
                            "textAttributes": [
                                {
                                    "content": "API",
                                    "fontSize": 26,
                                    "textColor": "#337FE5",
                                    "isBold": true
                                },
                                {
                                    "content": "some following content",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isBold": false
                                }
                            ]
                        },
                        {
                            "textAttributes": [
                                {
                                    "content": "some main content",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isUnderline": false
                                }
                            ]
                        }
                    ],
                    "layout": {
                        "x": "50%",
                        "y": "50%",
                        "width": "50%",
                        "height": "50%"
                    }
                }
			]
		}
	]
}'

Responses

🟢200OK

application/json

Body

displaySolutions

object

required

md5

string

required

fileName

string

required

url

string

required

playRelations

object

required

md5

string

required

fileName

string

required

url

string

required

playSolutions

object

required

md5

string

required

fileName

string

required

url

string

required

playlists

object

required

md5

string

required

fileName

string

required

url

string

required

scheduleConstraints

object

required

md5

string

required

fileName

string

required

url

string

required

planJson

object

required

md5

string

required

fileName

string

required

url

string

required

isSupportMd5Checkout

boolean

required

programName

string

required

Example

{
  "displaySolutions": {
    "md5": "1376da5787a1008d875c01af893a6900",
    "fileName": "display_solution.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/1727157294527/display_solution.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=sCRWAV4%2B1vref8IV0H4sXyCViDk%3D"
  },
  "playRelations": {
    "md5": "a36aba42bcf94b63c0ef9abadc8feaf8",
    "fileName": "RelationDescription.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/1727157294527/RelationDescription.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=pAbPAjVvJeHXodJYnTKDC6t26cs%3D"
  },
  "playSolutions": {
    "md5": "336459f8f6646685414d815e23b9dd6e",
    "fileName": "play_solution0.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/1727157294527/play_solution0.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=8Uv2D9jc0uFF31VuEfFEuHayeVw%3D"
  },
  "playlists": {
    "md5": "6094b47417d0b8e26e1f0ae86b95304b",
    "fileName": "playlist0.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/1727157294527/playlist0.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=Gfi6as9VQ7gHoRxhCz4qa1NFR7g%3D"
  },
  "scheduleConstraints": {
    "md5": "d72378022149d7f0e7f6a7ead62e7081",
    "fileName": "schedule_constraint0.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/1727157294527/schedule_constraint0.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=M6IGH6QwA5PRWO%2Fy48MAMb%2Fl70I%3D"
  },
  "planJson": {
    "md5": "5c134f93d12cd3b7fe4c5f29cbb47beb",
    "fileName": "planlist.json",
    "url": "https://novacloud-dev.oss-cn-hangzhou.aliyuncs.com/pingjl_sit/api/normal/2024-09-24/planlist.json?OSSAccessKeyId=LTAI5tE3ck6A2DexBqttYHVH&Expires=1727762095&Signature=37sPnng0AWjCYnLSYoACdpuNrEA%3D",
    "isSupportMd5Checkout": false,
    "programName": "API-202409241354552904-Program"
  }
}