离线导出 - NovaCloud-CN

提示

通过此接口可以为离线节目导出诺瓦播放协议

支持T卡2.0.0以上版本以及Vplayer4.0.0以上版本

请求参数

Header 参数

AppKey

string

接入键

必需

默认值:

Nonce

string

必需

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

CurTime

string

必需

当前 UTC 时间戳

CheckSum

string

请求签名

必需

Body 参数application/json

programType

integer

必需

节目类型，1-正常节目

planVersion

string

必需

协议版本号：V1，V2 如果T卡版本大于3.10.0.0601或者V卡版本大于4.1.1.0601,下发多行文本时走V2协议

schedule

object

必需

整个节目的时间排期，如果为空，会全天24小时循环播放；若节目级排期和page级排期同时设置，播放以排期交集为准

startDate

string

必需

播放开始日期，如：2020-04-12

endDate

string

必需

播放结束日期 ,如：2020-12-22

plans

object

具体播放计划

必需

pages

array [object {2}]

必需

需要播放的页面内容集合

name

string

页面名称

必需

widgets

array [object]

可选

组件数组，具体参考：节目组件目录

示例

{
    "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:00",
                "endTime": "23:00: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": [
                        "星期日",
                        "星期一",
                        "星期二",
                        "星期三",
                        "星期四",
                        "星期五",
                        "星期六"
                    ],
                    "suffixTemplates": [
                        "上午",
                        "下午"
                    ],
                    "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": "后面跟着的字",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isBold": false
                                }
                            ]
                        },
                        {
                            "textAttributes": [
                                {
                                    "content": "你好我是正文内容",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isUnderline": false
                                }
                            ]
                        }
                    ],
                    "layout": {
                        "x": "50%",
                        "y": "50%",
                        "width": "50%",
                        "height": "50%"
                    }
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-cn.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:00",
                "endTime": "23:00: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": [
                        "星期日",
                        "星期一",
                        "星期二",
                        "星期三",
                        "星期四",
                        "星期五",
                        "星期六"
                    ],
                    "suffixTemplates": [
                        "上午",
                        "下午"
                    ],
                    "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": "后面跟着的字",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isBold": false
                                }
                            ]
                        },
                        {
                            "textAttributes": [
                                {
                                    "content": "你好我是正文内容",
                                    "fontSize": 16,
                                    "textColor": "#FF0000",
                                    "isUnderline": false
                                }
                            ]
                        }
                    ],
                    "layout": {
                        "x": "50%",
                        "y": "50%",
                        "width": "50%",
                        "height": "50%"
                    }
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

displaySolutions

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

playRelations

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

playSolutions

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

playlists

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

scheduleConstraints

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

planJson

object

必需

md5

string

必需

fileName

string

必需

url

string

必需

isSupportMd5Checkout

boolean

必需

programName

string

必需

示例

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