3.TDDS Service API

### API URL: /service 完整url示例: ``` ws://192.168.123.123:2626/service ``` ### 说明 此接口用于从TDDS Server获取相关信息,如服务在线状态,TDDS或Console的在线状态,视频通道ID,某个通道的视频格式等。使用时WebSocket连接会立即返回请求结果。在此接口上收发消息时需需严格按照1.2节所述消息结构封装和解析数据流。**如果某个请求需要其它参数,则将参数以JSON结构化后放置在TDDS Server Message的data字段。** ## 此接口目前支持的请求包括以下消息类型 |类型名称|类型值|携带参数|结果中data字段说明| | --- | --- |---|---| |获取TDDS Server在线状态|100 |无|true表示在线,false表示不在线 |获取TDDS在线状态|101|无|true表示在线,false表示不在线 |获取TDDS Console在线状态|102|无|true表示在线,false表示不在线 |获取消息通知上传方在线状态|103|无|true表示在线,false表示不在线 |获取消息通知下载方在线状态|104|无|true表示在线,false表示不在线 |获取已在线的视频通道ID|105|无|一个包含所有在线通道ID的数组,如:[1,2,3] |获取某个通道的图像格式|106|通道ID|结构化的图像格式信息 |获取所有通道的图像格式|107|无 **请求示例一:** 如需获取TDDS Server在线状态,可构造以下JSON对象: ``` { "type": 100, "message": "" } ``` 响应示例: ``` { "type": 0, "message": "Service is online.", "data": true, "time": "2022/1/5 19:02:58" } ``` **请求示例二:** 如需获取已在线的视频通道ID,可构造以下JSON对象: ``` { "type": 105, "message": "" } ``` 响应示例 ``` { "type": 105, "message": "Got 3 uploading channels.", "data": [1,2,5], "time": "2022/1/5 19:08:03" } ``` **请求示例三** 如需获取通道1的图像格式,可构造以下JSON对象: ``` { "type": 106, "message":"" "data": 1 } ``` 响应示例 ``` { "type": 0, "message": "Success", "data": { "channelId": 1, "imageWidth": 640, "imageHeight": 360, "pixelFormat": 2 }, "time": "2022/1/5 19:17:48" } ```