VNNOX_API
Page tree

Versions Compared

Old Version 10

changes.mady.by.user NovaStar

Saved on

compared with

New Version Current

changes.mady.by.user NovaStar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

使用说明

同步播放器会5s上报一次心跳，服务端检测心跳是否存在是30s内如果没有心跳上报，代表心跳掉线，建议本接口30s调用一次

访问地址


Code Block
GET {host}/Rest/Player


Request-Parameters参数

参数名参数类型是否必填描述
limitint是每页返回记录数，范围1-100
offsetint是从哪一页开始，范围>=0
searchstring否按照播放器名称搜索
sortstring是名称排序，值为：name
sortTypestring是名称排序方式，asc/desc

Request-Headers参数

参数名参数类型是否必填描述
tokenstring是登录认证成功后获取的token信息

Request-Parameters请求示例：

Code Block
GET /Rest/Player?offset=0&limit=10&search=&sort=name&sortType=desc
token: 5cbcb7a1abd3cf038ae795c589574875ce92d44e
Accept-Encoding: gzip, deflate, br
Accept-Language: zh-CN,zh;q=0.8,en;q=0.6

返回结果

Code Block
titleStatus: 200 OK
{
    "http_code": 200,
    "data": {
        "taskType": [
            {
                "ttid": "1",
                "name": "重启",
                "english": "reboot",
                "synchronize": "1",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"重启\",\"en\":\"reboot\",\"jp\":\"再起動\"}"
            },
            {
                "ttid": "2",
                "name": "开关屏",
                "english": "switch screen",
                "synchronize": "1",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"开关屏\",\"en\":\"switch screen\",\"jp\":\"画面ON/OFF\"}"
            },
            {
                "ttid": "3",
                "name": "同步播放",
                "english": "synchronous playback",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "0",
                "language": "{\"zh\":\"同步播放\",\"en\":\"synchronous playback\",\"jp\":\"シンクロシステム\"}"
            },
            {
                "ttid": "4",
                "name": "双模切换",
                "english": "dual mode switching",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"双模切换\",\"en\":\"dual mode switching\",\"jp\":\"ダブルモード切替\"}"
            },
            {
                "ttid": "5",
                "name": "升级",
                "english": "software upgrade",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "0",
                "language": "{\"zh\":\"升级\",\"en\":\"software upgrade\",\"jp\":\"アップグレード\"}"
            }
        ],
        "immediatelyChoose": [
            {
                "ttid": "1",
                "name": "重启",
                "english": "reboot",
                "synchronize": "1",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"重启\",\"en\":\"reboot\",\"jp\":\"再起動\"}",
                "task": [
                    {
                        "task_id": "1",
                        "ttid": "1",
                        "name": "重启",
                        "english": "reboot",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"重启\",\"en\":\"Reboot\",\"jp\":\"再起動\"}"
                    }
                ]
            },
            {
                "ttid": "2",
                "name": "开关屏",
                "english": "switch screen",
                "synchronize": "1",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"开关屏\",\"en\":\"switch screen\",\"jp\":\"画面ON/OFF\"}",
                "task": [
                    {
                        "task_id": "2",
                        "ttid": "2",
                        "name": "开屏",
                        "english": "Turn on the screen",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"开屏\",\"en\":\"Turn on the screen\",\"jp\":\"スクリーンON\"}"
                    },
                    {
                        "task_id": "3",
                        "ttid": "2",
                        "name": "关屏",
                        "english": "Turn off the screen",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"关屏\",\"en\":\"Turn off the screen\",\"jp\":\"スクリーンOFF\"}"
                    }
                ]
            },
            {
                "ttid": "3",
                "name": "同步播放",
                "english": "synchronous playback",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "0",
                "language": "{\"zh\":\"同步播放\",\"en\":\"synchronous playback\",\"jp\":\"シンクロシステム\"}",
                "task": [
                    {
                        "task_id": "4",
                        "ttid": "3",
                        "name": "开启同步播放",
                        "english": "turn on sync play\r\nturn on sync play\r\n",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"开启同步播放\",\"en\":\"Turn on sync play\",\"jp\":\"シンクロ放送ON\"}"
                    },
                    {
                        "task_id": "5",
                        "ttid": "3",
                        "name": "关闭同步播放",
                        "english": "turn off sync play",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"关闭同步播放\",\"en\":\"Turn off sync play\",\"jp\":\"シンクロ放送OFF\"}"
                    }
                ]
            },
            {
                "ttid": "4",
                "name": "双模切换",
                "english": "dual mode switching",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "1",
                "language": "{\"zh\":\"双模切换\",\"en\":\"dual mode switching\",\"jp\":\"ダブルモード切替\"}",
                "task": [
                    {
                        "task_id": "8",
                        "ttid": "4",
                        "name": "外部输入源",
                        "english": "External input source",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"外部输入源\",\"en\":\"External input source\",\"jp\":\"外部入力\"}"
                    },
                    {
                        "task_id": "9",
                        "ttid": "4",
                        "name": "内部输入源",
                        "english": "Internal input source",
                        "is_support_timing": "1",
                        "language": "{\"zh\":\"内部输入源\",\"en\":\"Internal input source\",\"jp\":\"内部入力\"}"
                    }
                ]
            },
            {
                "ttid": "5",
                "name": "升级",
                "english": "software upgrade",
                "synchronize": "0",
                "asynchronous": "1",
                "is_support_control_plan": "0",
                "language": "{\"zh\":\"升级\",\"en\":\"software upgrade\",\"jp\":\"アップグレード\"}",
                "task": [
                    {
                        "task_id": "6",
                        "ttid": "5",
                        "name": "软件升级",
                        "english": "Software upgrade",
                        "is_support_timing": "0",
                        "language": "{\"zh\":\"软件升级\",\"en\":\"Software upgrade\",\"jp\":\"ソフトウェアアップグレード\"}"
                    },
                    {
                        "task_id": "7",
                        "ttid": "5",
                        "name": "软件升级",
                        "english": "Firmware upgrade",
                        "is_support_timing": "0",
                        "language": "{\"zh\":\"软件升级\",\"en\":\"Software upgrade\",\"jp\":\"ソフトウェアアップグレード\"}"
                    },
                    {
                        "task_id": "10",
                        "ttid": "5",
                        "name": "系统升级",
                        "english": "System upgrade\r\n",
                        "is_support_timing": "0",
                        "language": "{\"zh\":\"系统升级\",\"en\":\"System upgrade\",\"jp\":\"システムアップグレード\"}"
                    }
                ]
            }
        ],
        =name&sortType=asc HTTP/1.1
token: 5cbcb7a1abd3cf038ae795c589574875ce92d44e
Accept-Encoding: gzip, deflate, br
Accept-Language: zh-CN,zh;q=0.8,en;q=0.6


返回结果

Code Block
titleStatus: 200 OK
{
    "http_code": 200,
    "data": {
        "playerInfo": [
            {
                "player_id": "1760",
                "oid": "1954",
                "wid": "2859",
                "generate_time": "0000-00-00 00:00:00",
                "utc_generate_time": "0",
                "longitude": "",
                "latitude": "",
                "address": "西安市",
                "playerIdentifier": "295235b9c6283580661ad2e066680c1d",
                "playerName": "player_9",
                "remark": "",
                "playerEnable": "1",
                "autoDistribution": "1",
                "playerType": "1",
                "planGenerateStatus": "0",
                "player_media_item": [],
                "player_monitor_status": null,
                "player_upgrade": [],
                "player_download": null,
                "player_report_version": null,
                "scheduled_task": [],
                "isFirstVersion": false,
                "isUpgradeSoftware": false,
                "HeartbeatStatus": {
                    "isHeartbeatOverdue": 0
                },
                "playStatus": 0,
                "cacheInfo": {
                    "downloadInfo": false,
                    "firmwareDownloadInfo": false,
                    "OSDownloadInfo": false,
                    "studioUpgradeInfo": false,
                    "firmwareUpgradeInfo": false,
                    "OSUpgradeInfo": false,
                    "oldUpgradeInfo": false
                },
                "supportUpgradeSchedule": true,
                "upgradeInfo": [
                    {
                        "type": 1,
                        "upgradeType": 1,
                        "status": 1,
                        "info": false
                    }
                ],
                "emergencyHeartbeat": false,
                "licenseInfo": []
            },
            {
                "player_id": "1759",
                "oid": "1954",
                "wid": "2859",
                "generate_time": "0000-00-00 00:00:00",
                "utc_generate_time": "0",
                "longitude": "",
                "latitude": "",
                "address": "西安市",
                "playerIdentifier": "48b59b522c2db038e178ebce5d2b1dcc",
                "playerName": "player_8",
                "remark": "",
                "playerEnable": "1",
                "autoDistribution": "1",
                "playerType": "1",
                "planGenerateStatus": "0",
                "player_media_item": [],
                "player_monitor_status": null,
                "player_upgrade": [],
                "player_download": null,
                "player_report_version": null,
                "scheduled_task": [],
                "isFirstVersion": false,
                "isUpgradeSoftware": false,
                "HeartbeatStatus": {
                    "isHeartbeatOverdue": 0
                },
                "playStatus": 0,
                "cacheInfo": {
                    "downloadInfo": false,
                    "firmwareDownloadInfo": false,
                    "OSDownloadInfo": false,
                    "studioUpgradeInfo": false,
                    "firmwareUpgradeInfo": false,
                    "OSUpgradeInfo": false,
                    "oldUpgradeInfo": false
                },
                "supportUpgradeSchedule": true,
                "upgradeInfo": [
                    {
                        "type": 1,
                        "upgradeType": 1,
                        "status": 1,
                        "info": false
                    }
                ],
                "emergencyHeartbeat": false,
                "licenseInfo": []
            },
            ,
            {
                "player_id": "1753",
                "oid": "1954",
                "wid": "2859",
                "generate_time": "0000-00-00 00:00:00",
                "utc_generate_time": "0",
                "longitude": "",
                "latitude": "",
                "address": "西安市",
                "playerIdentifier": "45625d8163f868d44b3cb14e379941ba",
                "playerName": "player_2",
                "remark": "",
                "playerEnable": "1",
                "autoDistribution": "1",
                "playerType": "1",
                "planGenerateStatus": "0",
                "player_media_item": [],
                "player_monitor_status": {
                    "player_id": "1753",
                    "utc_monitor_turn_on_time": "0",
                    "reg_time": "2017-10-27 15:33:04",
                    "utc_reg_time": "0",
                    "monitorTurnOnTime": "2017-10-27 15:33:04",
                    "hostName": "DESKTOP-M6PGHLK",
                    "hostIp": "10.20.4.217",
                    "hostIdentifier": "60:45:CB:6D:09:B2",
                    "softwareName": "VNNOX Player V1.5.1",
                    "softwareVersion": "V1.5.1",
                    "monitorStatus": "0"
                },
                "player_upgrade": [],
                "player_download": null,
                "player_report_version": null,
                "scheduled_task": [],
                "player_window": [
                    {
                        "player_id": "1753",
                        "channel_id": "0",
                        "playerWidth": "1152",
                        "playerHeight": "384",
                        "windowId": "0",
                        "channel": null
                    }
                ],
                "isFirstVersion": false,
                "lastVersion": "V1.5.1",
                "isUpgradeSoftware": false,
                "isUpgradeOS": true,
                "HeartbeatStatus": {
                    "isHeartbeatOverdue": 2,
                    "heartbeatTime": "2017-10-27 15:48:46",
                    "code": [
                        "10000"
                    ]
                },
                "playStatus": 0,
                "cacheInfo": {
                    "downloadInfo": false,
                    "firmwareDownloadInfo": false,
                    "OSDownloadInfo": false,
                    "studioUpgradeInfo": false,
                    "firmwareUpgradeInfo": false,
                    "OSUpgradeInfo": false,
                    "oldUpgradeInfo": false
                },
                "supportUpgradeSchedule": true,
                "upgradeInfo": [
                    {
                        "type": 1,
                        "upgradeType": 1,
                        "status": 1,
                        "info": false
                    }
                ],
                "emergencyHeartbeat": false,
                "licenseInfo": []
            },
            {
                "player_id": "1762",
                "oid": "1954",
                "wid": "2859",
                "generate_time": "0000-00-00 00:00:00",
                "utc_generate_time": "0",
                "longitude": "",
                "latitude": "",
                "address": "西安市",
                "playerIdentifier": "849fa02768a323f2c54807abf52f4463",
                "playerName": "player_11",
                "remark": "",
                "playerEnable": "1",
                "autoDistribution": "1",
                "playerType": "1",
                "planGenerateStatus": "0",
                "player_media_item": [],
                "player_monitor_status": null,
                "player_upgrade": [],
                "player_download": null,
                "player_report_version": null,
                "scheduled_task": [],
                "isFirstVersion": false,
                "isUpgradeSoftware": false,
                "HeartbeatStatus": {
                    "isHeartbeatOverdue": 0
                },
                "playStatus": 0,
                "cacheInfo": {
                    "downloadInfo": false,
                    "firmwareDownloadInfo": false,
                    "OSDownloadInfo": false,
                    "studioUpgradeInfo": false,
                    "firmwareUpgradeInfo": false,
                    "OSUpgradeInfo": false,
                    "oldUpgradeInfo": false
                },
                "supportUpgradeSchedule": true,
                "upgradeInfo": [
                    {
                        "type": 1,
                        "upgradeType": 1,
                        "status": 1,
                        "info": false
                    }
                ],
                "emergencyHeartbeat": false,
                "licenseInfo": {
                    "license_uuid": "010a3e3e-c739-48df-abf6-fa77104ce32b",
                    "is_overdue": false,
                    "expire_label": "2023-04-15 23:59:59"
                }
            },
            {
                "player_id": "1761",
                "oid": "1954",
                "wid": "2859",
                "generate_time": "0000-00-00 00:00:00",
                "utc_generate_time": "0",
                "longitude": "",
                "latitude": "",
                "address": "西安市",
                "playerIdentifier": "9f2140d32e7b5834bb398db378acf151",
                "playerName": "player_10",
                "remark": "",
                "playerEnable": "1",
                "autoDistribution": "1",
                "playerType": "1",
                "planGenerateStatus": "0",
                "player_media_item": [],
                "player_monitor_status": null,
                "player_upgrade": [],
                "player_download": null,
                "player_report_version": null,
                "scheduled_task": [],
                "isFirstVersion": false,
                "isUpgradeSoftware": false,
                "HeartbeatStatus": {
                    "isHeartbeatOverdue": 0
                },
                "playStatus": 0,
                "cacheInfo": {
                    "downloadInfo": false,
                    "firmwareDownloadInfo": false,
                    "OSDownloadInfo": false,
                    "studioUpgradeInfo": false,
                    "firmwareUpgradeInfo": false,
                    "OSUpgradeInfo": false,
                    "oldUpgradeInfo": false
                },
                "supportUpgradeSchedule": true,
                "upgradeInfo": [
                    {
                        "type": 1,
                        "upgradeType": 1,
                        "status": 1,
                        "info": false
                    }
                ],
                "emergencyHeartbeat": false,
                "licenseInfo": []
            }
        ],
        "count": "11"
    },
    "status": [
        10000001
    ]
}

返回参数说明

参数名类型说明
data.playerInfoarray返回的播放器列表
data.playerInfo.player_idstring播放器编号
data.playerInfo.playerNamestring播放器名称
data.playerInfo.HeartbeatStatusarray播放器心跳信息
data.playerInfo.HeartbeatStatus.isHeartbeatOverdueint心跳状态，0-无心跳报告，1-心跳过期，2-心跳正常
data.playerInfo.HeartbeatStatus.heartbeatTimestring最后一次拿到心跳的时间
data.countstring播放器总数量
statusarray登录状态码

返回状态码说明

状态码说明
10000001
数据获取成功
40000001token过期
其他码数据获取失败

...