六、功能接口章节--视频管理接口部分

六、功能接口章节--视频管理接口部分


视频接口简介

视频功能基于GB/T 28181国标协议开发，是一个功能齐全的视频管理中心。该视频中心旨在提供高效、可靠的视频监控和管理解决方案，满足各类场景下的实时监控要求。

本IOT中继平台集成了开源流媒体服务器ZLMediaServer提供流转发服务，负责将GB28181设备/平台推送的PS流转成 ES流，然后提供RTSP、RTMP、FLV、HLS多种格式进行分发，实现web浏览器、手 机浏览器、微信、PC客户端等各种终端无插件播放。 支持视频设备 IPC、NVR的接入。

视频中心提供的功能有：

视频直播：支持FLV、HLS格式的多路视频直播

视频录制：支持录制视频到服务器中进行存储；支持视频录制计划，按设置计划时间录制视频；提供录制视频的查询、回放、下载服务。

云台控制：支持转向、聚焦等云台控制，提供httpAPI接口向接入的视频设备下达云台控制指令。控制云台进行上、下、左、右、左上、左下、右上、右下等八方位方向的移动；控制云台镜头的变倍、聚焦和光圈大小、预置点、巡航等功能

a、查询视频设备列表

接口功能 本接口主要提供httpAPI接口查询接入本IOT中继平台的视频设备列表。

Request URL: http://192.168.0.105:18080/nvrDevice/getNvrDeviceList
域名访问URL： http://iotbox.iotrelay.cn:8080/api/nvrDevice/getNvrDeviceList

Request Method: GET

数据提交格式 Query String Parameters

请求头参数 Authorization

请求头参数说明：

参数名类型必须描述
AuthorizationHeader是固定值：字符串"Bearer" +"token"组成， "token"为上述登录接口获取的属性值，如：请求头中


“Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM”

请求体参数说明：

参数名类型必须描述
sipIdstring否接入视频设备SIP_ID标识，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如：黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值
备注： 视频设备SIP_ID标识参数不填，则查询接入本IOT中继平台的所有视频设备列表。

正确响应结果示例：

{
      "code": "0",
      "msg": "success",
      "data": [
                {
                  "id": "1568447122901069825",
                  "sipId": "44090000001111000001",
                  "deviceSn": "20220910",
                  "deviceName": "我的NVR",
                  "manufacturer": "浙江海康",
                  "brand": "海康",
                  "model": "HIKI12324332",
                  "createTime": "2022-09-10 11:51:49",
                  "updateTime": "null",
                  "status": "0",
                  "isDeleted": "0",
                  "onlineStatus": "1",
                  "remark": "备注说明",
                  "channelsData": [
                   {
                      "id": "1568447122922041345",
                      "channelSn": "44090000001321000001",
                      "channelName": "通道44090000001321000001",
                      "nvrDeviceId": "1568447122901069825",
                      "monitorType": "2",
                      "address": "大门口",
                      "isControl": "1",
                      "createTime": "2022-09-10 11:51:49",
                      "updateTime": "null",
                      "status": "1",
                      "isDeleted": "0",
                      "onlineStatus": "1",
                      "isRecording": "0",
                      "remark": "null",
                      "offlineTime": "null",
                      "onlineTime": "null",
                   },
                   {
                      "id": "1568447122989150209",
                      "channelSn": "44090000001321000002",
                      "channelName": "通道44090000001321000002",
                      "nvrDeviceId": "1568447122901069825",
                      "monitorType": "1",
                      "address": "作业面",
                      "isControl": "1",
                      "createTime": "2022-09-10 11:51:49",
                      "updateTime": "null",
                      "status": "0",
                      "isDeleted": "0",
                      "onlineStatus": "0",
                      "isRecording": "0",
                      "remark": "null",
                      "offlineTime": "null",
                      "onlineTime": "null",
                   },
                   {
                      "id": "1568447123052064769",
                      "channelSn": "44090000001321000003",
                      "channelName": "通道44090000001321000003",
                      "nvrDeviceId": "1568447122901069825",
                      "monitorType": "2",
                      "address": "塔吊",
                      "isControl": "1",
                      "createTime": "2022-09-10 11:51:49",
                      "updateTime": "null",
                      "status": "1",
                      "isDeleted": "0",
                      "onlineStatus": "0",
                      "isRecording": "0",
                      "remark": "null",
                      "offlineTime": "null",
                      "onlineTime": "null",
                   }
             ],
             "sipService": "null",
             "sipServiceRealm": "null",
             "sipLocalPort": "null",
             "sipServicePort": "null",
             "sipPassword": "null",
             "sipServiceAddress": "null"
          },
          ]
}

响应体参数说明：

参数名类型描述
sipIdstring接入视频设备ID标识，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如：黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值
deviceSnstring视频设备编号 如：黄色 “20220910”
deviceNamestring视频设备名称 如：黄色 “我的NVR”
manufacturerstring生产厂家 如：黄色 “浙江海康”
brandstring品牌 如：黄色 “海康”
modelstring型号 如：黄色 “HIKI12324332”
createTimedatetime创建时间
updateTimedatetime修改时间
statusinteger设备状态1、有效，0、无效
isDeletedinteger是否逻辑删除 0、否；1、是
onlineStatusinteger在线状态 0、离线；1、在线 2、待接入
remarkstring备注描述



channelSnstring通道编号 如：黄色 “44090000001321000001”
channelNamestring通道名称 如：黄色 “通道44090000001321000001”
nvrDeviceIdintegerNVR设备ID 如：黄色 “1568447122901069825”
monitorTypeinteger监控类别1、枪机2、球机3、半球4、红外相机5、其他
addressstring安装地址
isControlinteger是否可云台控制， 1、 可控制 ； 0 、不可控制
isRecordinginteger录像状态 0、停止；1、录像进行中
offlineTimedatetime最新离线时间
onlineTimedatetime最新上线时间

错误响应结果示例：

{
      "code": "-1",
      "msg": "fail:数据查询失败"
}
b、查询视频通道列表

接口功能 本接口主要提供httpAPI接口查询接入本IOT中继平台的视频通道列表。

Request URL: http://192.168.0.105:18080/nvrDevice/getNvrDeviceChannelList
域名访问URL： http://iotbox.iotrelay.cn:8080/api/nvrDevice/getNvrDeviceChannelList

Request Method: GET

数据提交格式 Query String Parameters

请求头参数 Authorization

请求头参数说明：

参数名类型必须描述
AuthorizationHeader是固定值：字符串"Bearer" +"token"组成， "token"为上述登录接口获取的属性值，如：请求头中


“Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM”

请求体参数说明：

参数名类型必须描述
sipIdstring否接入视频设备SIP_ID标识，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如：黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值
channelSnstring否IOT接入视频设备通道编号ID，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–视频监控通道编号ID 如：黄色 “44090000001321000002”
channelNamestring否视频设备通道名称
monitorTypeinteger否监控类别:1、枪机;2、球机;3、半球;4、红外相机;5、其他;

正确响应结果示例：

{
      "code": "0",
      "msg": "success",
      "data": [
                   {
                      "id": "1568447122922041345",
                      "channelSn": "44090000001321000001",
                      "channelName": "通道44090000001321000001",
                      "nvrDeviceId": "1568447122901069825",
                      "monitorType": "2",
                      "address": "大门口",
                      "isControl": "1",
                      "createTime": "2022-09-10 11:51:49",
                      "updateTime": "null",
                      "status": "1",
                      "isDeleted": "0",
                      "onlineStatus": "1",
                      "isRecording": "0",
                      "offlineTime": "null",
                      "onlineTime": "null",
                      "sipId": "44090000001111000001",
                      "deviceSn": "20220910",
                      "deviceName": "我的NVR",
                      "brand": "null",
                      "model": "null",
                      "regTime": "null",
                      "remark": "null"
                   },
                   {
                      "id": "1568447122989150209",
                      "channelSn": "44090000001321000002",
                      "channelName": "通道44090000001321000002",
                      "nvrDeviceId": "1568447122901069825",
                      "monitorType": "1",
                      "address": "作业面",
                      "isControl": "0",
                      "createTime": "2022-09-10 11:51:49",
                      "updateTime": "null",
                      "status": "1",
                      "isDeleted": "0",
                      "onlineStatus": "1",
                      "isRecording": "0",
                      "offlineTime": "null",
                      "onlineTime": "null",
                      "sipId": "44090000001111000001",
                      "deviceSn": "20220910",
                      "deviceName": "我的NVR",
                      "brand": "null",
                      "model": "null",
                      "regTime": "null",
                      "remark": "null"
                   }
                ]
}

响应体参数说明：

参数名类型描述
channelSnstringIOT接入视频设备视频监控通道编号ID， 如：黄色 “44090000001321000002”
channelNamestring通道名称
nvrDeviceIdintegerNVR设备ID
monitorTypeinteger监控类别1、枪机2、球机3、半球4、红外相机5、其他
addressstring视频通道安装地址 如：黄色 “大门口”
isControlinteger是否可云台控制， 1、 可控制； 0、 不可控制
createTimedatetime创建时间
updateTimedatetime修改时间
statusinteger设备状态1、有效，0、无效
isDeletedinteger是否逻辑删除 0、否；1、是
onlineStatusinteger在线状态 0、离线；1、在线 2、待接入
isRecordinginteger录像状态 0、停止；1、录像进行中
offlineTimedatetime最新离线时间
onlineTimedatetime最新上线时间
sipIdstring接入视频设备ID标识 如：黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值
channelSnstring通道编号 如：黄色 “44090000001321000001”
deviceSnstring视频设备编号 如：黄色 “20220910”
deviceNamestring视频设备名称 如：黄色 “我的NVR”
manufacturerstring视频设备生产厂家
brandstring视频设备品牌
modelstring设备型号
regTimedatetime设备注册时间
remarkstring备注描述

错误响应结果示例：

{
      "code": "-1",
      "msg": "fail:数据查询失败"
}
c、查询视频流是否在线

接口功能 本接口主要提供httpAPI接口用于查询对应通道视频流是否在线。

Request URL: http://192.168.0.105:18080/api/media/getIsMediaOnline
域名访问URL： http://iotbox.iotrelay.cn:8080/api/api/media/getIsMediaOnline

Request Method: GET

数据提交格式 Query String Parameters

请求头参数 Authorization

请求头参数说明：

参数名类型必须描述
AuthorizationHeader是固定值：字符串"Bearer" +"token"组成， "token"为上述登录接口获取的属性值，如：请求头中


“Authorization” : “Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJiNjE3OGVlN2ZhNWM0OWU2ODlmMGEzNjIxNzkxYzk2OCIsInN1YiI6IntcInVzZXJJZFwiOlwiNDlcIixcInVzZXJOYW1lXCI6XCIxMzQzNzE1NjU2OVwiLFwibmlja05hbWVcIjpcIjQ0MDgwMDAwMDAxMTExMDAwMDE3XCJ9IiwiaXNzIjoic2oiLCJpYXQiOjE2OTcxNTk2NjgsImV4cCI6MTY5NzE2MTQ2OH0.4C3GJIF5ejmySHy9l_LmheoCs5jknq17h9tPsZB3dIM”

请求体参数说明：

参数名类型必须描述
deviceIdstring是接入视频设备ID标识，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–SIP用户认证ID 如：黄色 "44080000001111000001"为接入视频设备SIP用户认证ID值
channelIdstring是IOT接入视频设备视频监控通道编号ID，对应位置在 视频设备–我的接入配置–监控设备接入配置信息–视频监控通道编号ID 如：黄色 “44090000001321000001”

正确响应结果示例：

{
      "code": "0",
      "msg": "媒体流在线",
      "data": {
                  "code": "0",
                  "online": "true"
                   }
}

响应体参数说明：

参数名类型描述
codeinteger状态码，0、成功；-1 代表失败
msgstring查询返回消息说明
onlineboolean媒体流在线状态：true 媒体流在线，false 媒体流不在线

错误响应结果示例：

{
      "code": "-1",
      "msg": "fail:数据查询失败"
}


武汉市宜联科技有限责任公司
联系我们
  • 电话：19945021328
  • 邮箱：276139610@qq.com
  • Q  Q：978243478

物联网平台

扫一扫 手机访问

物联网平台

微信 扫一扫

武汉市宜联科技有限责任公司
武汉市宜联科技有限责任公司
  • 地址：湖北省武汉市东湖新技术开发区文华园路8号
  • 电话：19945021328
  • 邮箱：276139610@qq.com
  • Q  Q：978243478
IOT中继宝盒 长按关注宜联科技公众号
电话咨询
产品中心
回到顶部

QQ在线咨询

点击这里给我发消息 咨询客服专员

QQ咨询

专业咨询

199-4502-1328

电话咨询

微信扫一扫

IOT中继宝盒

微信咨询
返回顶部