海康云眸 IoT API
  1. 视频集成方案
海康云眸 IoT API
  • 产品介绍
  • 能力概览
  • 错误码表
  • 报警类型表
  • 常见问题
  • 示例DEMO
  • 快速入门
    • 接口调用说明
    • 生成授权凭证
      POST
  • 基础服务能力
    • 设备分组管理
      • 新增组
      • 删除组
      • 更新组
      • 获得单个组详情
      • 查询所有节点列表
      • 查找组的下级节点
    • 设备管理
      • 注册设备
      • 注销设备
      • 修改设备名称
      • 获得单个设备信息
      • 获得设备列表
      • 获取设备总数
      • 查询设备状态
    • 设备确权
      • 确权流程说明
      • 下线确认
      • 上线确认
    • 通道管理
      • 查询设备下通道列表
      • 同步设备下通道
      • 修改通道名称
    • 人员管理
      • 添加人员
      • 更新人员信息
      • 删除人员信息
      • 获得单个人员详情
      • 人脸评分标准配置接口
      • 人员人脸更新
      • 人员人脸删除
  • 报警能力管理
    • 获取报警能力列表
    • 修改报警能力状态
  • 视频服务能力
    • 视频对接指南
    • 视频参数配置
      • 视频设备码流参数配置指南
      • 接口配置
        • 获取音视频单通道编码能力
        • 获取音视频单通道编码配置
        • 设置音视频单通道编码配置
    • 视频集成方案
      • web视频控件
      • UIKIT
      • 微信小程序
      • 移动端SDK
        • Android
        • IOS
        • 错误码对照表
      • 标准流预览
        • 开通标准流预览功能
        • 获取标准流预览地址
        • 获取预览/回放地址
      • 互动直播间
        • 创建直播间
        • 编辑直播间
        • 删除直播间
        • 查询直播间列表
        • 设置直播间状态
        • 账号充值
    • 设备视频加密
      • 关闭设备视频加密
      • 开启设备视频加密
    • 云台控制
      • 开始云台控制
      • 停止云台控制
      • 3D放大
    • 预置点操作
      • 添加预置点
      • 更新预置点
      • 清除预置点
      • 调用预置点
      • 加载预置点
    • 取流认证
      GET
    • 远程抓图
      POST
  • 门禁服务能力
    • 门禁对接指南
    • 卡片操作
      • 新增卡片
      • 删除卡片
      • 根据人员编号删除卡片
    • 门禁计划
      • 计划模板管理
        • 周计划模板添加/更新
        • 周计划模板获取
        • 周计划模板删除
        • 假日计划模板添加/更新
        • 假日计划模板获取
        • 假日计划模板删除
      • 门禁计划管理
        • 周计划配置
        • 周计划获取
        • 假日计划配置
        • 假日计划获取
        • 假日组计划配置
        • 假日组计划获取
        • 门禁计划配置
        • 门禁计划聚合配置
        • 门禁计划获取
        • 清空门禁计划
    • 权限分组
      • 权限组新增
      • 权限组更新
      • 权限组删除
      • 获取权限组列表
      • 权限组绑定人员
      • 权限组解绑人员
      • 权限组获取人员编号列表
      • 权限组绑定设备
      • 权限组解绑设备
      • 权限组获取设备序列号列表
      • 人员权限信息查询
    • 权限下发
      • 根据权限组下发权限
      • 查询下发失败记录
      • 下发所有失败人员
      • 清空设备本地权限
      • 获取设备能力集
      • 人员权限信息更新
    • 远程控门
      • 远程控门
      • 远程呼梯
    • 可视对讲
      • 设置可视对讲通知地址
      • 可视对讲交互事件通知
      • 获取可视对讲通知地址
    • 人员信息采集
      • 远程采集方式
        • 规则配置
        • 获取规则配置
        • 采集身份证信息
        • 采集卡信息
        • 采集指纹信息
        • 采集人脸信息
        • 获取人脸采集进度
      • 本地采集方式
        • 规则配置
        • 获取规则配置
        • 录入人员信息
        • 查询采集数据
        • 获取采集状态信息
        • 删除全部采集数据
        • 根据人员编号删除采集数据
    • 多重认证
      • 获取群组配置
      • 群组配置
      • 清除群组配置
      • 获取多重认证配置
      • 设置多重认证配置
    • 访客二维码生成
    • 设备本地事件查询
  • 边缘人脸服务能力
    • 边缘人脸对接指南
    • 人脸库管理
      • 创建人脸库
      • 删除全部人脸库
      • 删除单个人脸库
      • 获取所有人脸库基本参数
      • 批量设置人脸库基本参数
      • 获取单个人脸库基本参数
      • 设置单个人脸库基本参数
      • 查询人脸库剩余人脸数及磁盘容量
    • 人脸库人脸管理
      • 查询单个人脸库中人脸信息
      • 删除单个人脸库中人脸
    • 人脸下发入库
      • 人脸批量异步下发
      • 查询人脸异步下发任务状态
      • 查询人脸异步下发所有任务状态
      • 人脸下发底图入库状态查询
      • 人脸异步下发任务删除
    • 设置人脸比对参数配置
      • 设置人脸比对参数配置
      • 获取人脸比对参数配置
      • 设置人脸比对/陌生人比对联动配置
    • 客流统计
      • 客流统计参数配置
      • 客流统计参数配置获取
      • 查询客流数据
  • 消息通道
    • 对接指南
    • 消息类型定义
    • 消息通道API
      • 创建消费者
      • 消费消息
      • 提交偏移量
  • 其他设备能力
    • 萤石探测器
      • 获取探测器列表
      • 关联探测器
      • 设置探测器状态
      • 删除探测器
      • 获取可关联的IPC列表
      • 获取已关联的IPC列表
      • 设置探测器与IPC的关联关系
      • 修改探测器名称
      • 一键消警
    • 区域热度
      • 获取区域关注度配置
      • 区域关注度配置
      • 生成热度图
      • 获取热度图
      • 获取热度图配置
      • 设置热度图配置
    • 设备校时
      • 获取设备校时配置
      • 配置设备校时
      • 获取NTP服务器配置
      • 配置NTP服务器
      • 获取指定NTP服务器配置
      • 配置指定NTP服务器参数
    • 萤石云储存
      • 设备开通云存储
      • 开启/关闭云存储
      • 获取设备云存储信息
    • 视频安全帽
      • 设备本地开关权限控制
      • 设备录像开关
      • 设备立即上报按键触发抓图事件
      • 设备立即上报状态信息
      • 设备补光灯开关
      • 设备激光灯开关
    • 报警主机
      • 获取子系统列表
      • 获取防区列表
      • 获取主机状态
      • 获取所有防区状态
      • 子系统布防
      • 子系统撤防
    • 设备布撤防
  • 历史接口
    • 组管理
      • 新增组
      • 修改组
      • 删除组
      • 获取所有组
      • 查找组的下级节点
    • 组管理V2
      • 新增组
      • 修改组
      • 删除组
      • 获取所有组
      • 获取单个组信息
      • 查找组的下级节点
    • 设备管理
      • 注册设备
      • 注销设备
      • 获取设备列表
      • 获取单个设备信息
      • 修改设备名称
      • 获取设备总数
      • 设备布撤防
    • 通道管理
      • 查询设备下通道列表
      • 同步设备下通道
      • 修改通道名称
      • 设备抓图
    • 标准流预览
      • 关闭设备视频加密
      • 开通标准流预览功能
      • 获取标准流预览地址
      • 获取指定有效期标准流预览地址
    • 云台操作
      • 开始云台控制
      • 停止云台控制
      • 添加预置点
      • 调用预置点
      • 清除预置点
    • 门禁管理
      • 门禁管理
        • 人员下发
        • 人员更新
        • 人员查询
        • 人员删除
        • 卡下发
        • 卡更新
        • 卡查询
        • 卡删除
        • 人脸下发
        • 人脸修改
        • 人脸查询
        • 人脸删除
        • 访客二维码生成
        • 远程控门
        • 可视对讲交互事件通知
        • 可视对讲通知地址配置
      • 门禁批量管理
        • 注册人员信息
        • 批量注册人员信息
        • 更新人员信息
        • 查询人员列表
        • 删除人员信息
        • 批量下发
        • 查询任务状态
        • 查询任务详情
      • 门禁计划
        • 计划模板管理
          • 周计划模板添加/更新
          • 周计划模板获取
          • 周计划模板删除
          • 假日计划模板添加/更新
          • 假日计划模板获取
          • 假日计划模板删除
        • 门禁计划管理
          • 周计划配置
          • 周计划获取
          • 假日计划配置
          • 假日计划获取
          • 假日组计划配置
          • 假日组计划获取
          • 门禁计划配置
          • 门禁计划聚合配置
          • 门禁计划获取
          • 清空门禁计划
    • 超脑人脸管理
      • IO管理
        • 获取设备IO端口状态
        • 获取设备指定输出口信息
        • 配置设备指定输出口信息
        • IO输出
      • 人脸管理
        • 删除人脸
        • 查询人脸信息
        • 查询人脸列表
      • 人脸库管理
        • 创建人脸库
        • 查询人脸库容量
        • 删除全部人脸库
        • 删除指定人脸库
        • 查询人脸库基本参数
        • 设置人脸库基本参数
        • 查询指定人脸库基本参数
        • 设置指定人脸库基本参数
        • 查询人脸比对参数
        • 配置人脸比对参数
      • 人员信息管理
        • 注册人员信息
        • 查询人员列表
        • 注销人员信息
      • 获取磁盘基本信息
    • 下发任务管理
      • 下发人脸
      • 任务状态查询
      • 人脸下发状态查询
      • 删除任务
  • 健康码分析能力
    • 健康码识别
    • 行程码识别
    • 核酸报告识别
  • 获取access_token
    POST
  1. 视频集成方案

微信小程序

1.开发指南#

本文将帮助您学习如何在微信开发者工具中接入云眸视频直播、回放。开发者通过接入RTMP地址的方式即可获取云眸提供的实时视频预览,视频回放等服务。

1.1 准备工作#

1、注册微信小程序,在创建自己的微信小程序之前,首先需要注册小程序账号,有如下账号类型,我们选择 「小程序」 类型。请用您的企业账号完成后续注册。
CtwQEl-2HGWAIU35AACcJr3yRTw928.png
2、下载并安装微信开发者工具。
3、云眸预览、回放接入小程序依赖微信实时音视频播放组件live-player,根据微信实时音视频接入文档,您的小程序需要通过类目审核。您可登录微信公众平台 ,在左侧单击 「设置」,查看您的服务类目是否为live-player组件支持的小程序服务类目。您可点击右侧 「详情」 进行服务类目添加。
image.png
服务类目可以按需自行选择,如有疑问可以点击下图中的咨询客服进行咨询
image.png
您可登录微信公众平台,在左侧导航栏单击 「开发」,然后单击 「接口设置」 ,自助开通该组件权限。
image.png
4、在微信小程序中请求云眸API时,需预先设置通讯域名,小程序只可以和指定的域名进行网络通讯。您可以登录微信公众平台,在左侧导航栏单击 「开发」,然后单击 「开发设置」,在 「服务器域名」 区域,单击 「修改」,进行配置。
image.png

2.小程序开发#

2.1视频播放开发示例#

我们使用微信提供的 live-player组件进行视频播放,在 .wxml文件中引入该组件,我们为live-player组件指定id值,用于创建 LivePlayerContext 对象,以操作live-player组件。
live-player组件部分属性说明如下:
bindstatechange:监听播放状态变化,通过e.detail.code获取当前播放状态值,部分状态码如下所示。
mode属性默认为live(直播模式),小程序live-player组件为实时通话模式(mode=”RTC”),该模式时延更低。
src:您的设备播放地址,目前仅支持tmp格式。
autoplay:true表示自动播放,false表示手动播放。
cover-view组件 可覆盖在live-player组件之上,用于展示“播放按钮”、”全屏按钮”等播放器辅助功能。通过hidden="{true}"进行隐藏,hidden="{false}"进行展示。
         <live-player id="previewPlayer" binderror="error" bindstatechange="statechange" mode="RTC" src=""  autoplay="true" >
         </live-player>
         <!-- 播放停止状态 -->
         <cover-view class="video-loaing video-ready" hidden="true">
             <cover-image class="loading-gif" src="../live/images/live/landscape_play.png" catchtap="handlePlay">
             </cover-image>
         </cover-view>
        
         let livePlayerContext;
         Page({
             data: {
                 videoSrc: '', // 视频播放地址
                 videoLoadingStatus: 0, // 播放按钮展示状态
             },
             onLoad: function () {
                 livePlayerContext = wx.createLivePlayerContext('previewPlayer');
                 // 调用接口获取videoSrc视频播放地址
             },
             // 播放状态监听
             statechange(e) {
             const { code } = e.detail;
             switch (code){
               case 2007: //启动loading
                 break;
               case 2001: //连接服务器 
                 break;
               case 2002: //已经连接 RTMP 服务器,开始拉流 
                    break;
               case 2008: // 解码器启动
                 console.log("case 2008: //解码器启动");
                 break;
               case 2009: //视频分辨率改动
                  console.log("case 2009: //视频分辨率改动");
                 this.handlePlay(); // 视频分辨率改动可能导致播放暂停,可调用handlePlay()重启播放
                 break;
               case 2004: 
                 console.log("case 2004: // 视频播放开始");
                 break;
               case 2003: 
                   console.log("case 2003: //网络接收到首个视频数据包(IDR)");
                   break;
               case 2103: //网络断连, 已启动自动重连(本小程序不自动重连)
                   break;
               case 3001:
               case 3002:
               case 3003:
               case 3005: // RTMP 读/写失败,之后会发起网络重试
                   console.log("播放失败");
                   break;
               case 2105: // 当前视频播放出现卡顿
                 break;
               case -2301: // 经多次重连抢救无效,更多重试请自行重启播放
                 break;
             }
           },
             // 播放按钮
               handlePlay(e){
                   livePlayerContext.play({
                   success: ()=>{
                       // Do some thing
                   },
                   fail: (error)=>{
                       // Do some thing
                   }
                   })
               },
         })
        

3.接口说明#

3.1 获取直播/回放RTMP地址#

1.我们提供接口获取设备回放rtmp地址。依赖根据时间获取存储文件信息 接口 ( https://api2.hik-cloud.com/v1/carrier/wing/endpoint/video/getFileInfoByTime) 返回字段startTime,endTime,获取回放时间片段。
2.获取RTMP直播/回放地址接口说明:
         https://api2.hik-cloud.com/v1/carrier/wing/endpoint/video/getVideoUrl
        
请求方式: GET
请求参数
参数名类型示例描述是否必选
deviceSerialString203751922设备序列号Y
channelNoInteger1通道号Y
codeString1ezopen协议地址的设备的视频加密密码N
protocolString3流播放协议,1-ezopen、2-hls、3-rtmp、4-flv,默认为1N
qualityString1视频清晰度,1-高清,2-标清N
startTimeString2019-12-01 00:00:00本地录像回放开始时间N
stopTimeString2019-12-01 00:00:00本地录像回放结束时间N
expireTimeString86400过期时间N
typeString1ezopen协议地址的类型,1-预览,2-本地录像回放,3-云存储录像回放,非必选,默认为1N
supportH265Integer1是否要求播放视频为H265编码格式N
gbchannelString1国标设备的通道编号N
HTTP请求报文
         GET /v1/carrier/wing/endpoint/video/getVideoUrl HTTP/1.1
         Host: api2.hik-cloud.com
         
         channelNo=1&deviceSerial=203751922&protocol=3&quality=1&expireTime=86400
        
响应数据
         {
             "msg": "Operation succeeded",
             "code": "200",
             "data": {
                 "id": "247116619786670080",
                 "url": "rtmp://rtmp01open.ys7.com:1935/v3/openlive/203751922_1_2?expire=1605275593&id=247116619786670080&t=60ac6e4fd97e71e3e2fcceb792b042d8023cb73b6bd39c6ca769605a7d65dd2e&ev=100", //播放地址
                 "expireTime": "2020-11-13 21:53:13" //过期时间
             }
         }
        
返回码返回消息描述
200操作成功请求成功
10001参数错误校对参数
20001摄像头不存在摄像头不存在
20002设备不存在设备不存在
20007设备离线设备离线
20018该用户不拥有该设备该用户不拥有该设备
49999数据异常接口调用异常
50000系统错误系统错误
60019设备已加密设备已加密

3.2 获取设备回放时间片段接口地址说明#

我们提供获取设备回放片段的接口地址。
获取设备回放时间片段接口地址说明:
           https://api2.hik-cloud.com/v1/carrier/wing/endpoint/video/getFileInfoByTime
          
请求方式: GET
请求参数
参数名类型示例描述是否必选
deviceSerialString203751922设备序列号Y
channelNoString1通道号Y
startTimelong1378345128000起始时间,时间格式为:1378345128000。非必选,默认为当天0点N
endTimelong1378345128000结束时间,时间格式为:1378345128000。非必选,默认为当前时间N
recTypeint2回放源,0-系统自动选择,1-云存储,2-本地录像。非必选,默认为0N
HTTP请求报文
         GET /v1/carrier/wing/endpoint/video/getFileInfoByTime HTTP/1.1
         Host: api2.hik-cloud.com
         
         deviceSerial=427734203&channelNo=1&startTime=1378345128000&endTime=1378345128000&recType=0
        
响应数据
         {
             "code": "200",
             "msg": "操作成功",
             "data": [
                 {
                     "recType": 0, //回放源,0-系统自动选择,1-云存储,2-本地录像
                     "startTime": 1378345128000, // 文件开始时间
                     "endTime": 1378345128000, // 文件结束时间
                     "deviceSerial": "409864662", //设备序列号
                     "cameraNo": "1", // 设备通道号
                     "localType": "ALLEVENT", // 文件类型 0:ALARM 1:TIMING 2:IO */
                     "channelType": "D", // 该字段已废弃
                     "id": 20432171600, // 云存储信息主键ID
                     "fileId": "20432171600", // 文件ID
                     "ownerId": "chenyong", // 文件所属用户ID
                     "fileType": 1, //  文件类型0:目录1:视频文件2:图片文件3:音频文件
                     "fileName": "", // 文件名称
                     "cloudType": 1, //  该字段已废弃
                     "fileIndex": "5d5b6d94-13e8-440b-a25b-00eda521c35f", // 文件在云存储上的唯一索引
                     "fileSize": 4011828, // 文件大小,单位B
                     "locked": 0, // 是否被锁定。1-锁定;0-未锁定
                     "createTime": "2016-08-22 13:59:13", // 创建时间
                     "crypt": 22, // 是否加密0--不加1--加密
                     "keyChecksum": "", //  验证码MD5值
                     "videoLong": 150000, // 录像长度
                     "coverPic": "https://218.244.139.5:0/api/cloud?method=download&fid=a14f8348-1dd1-11b2-aef9-dbed68cc4c3e&session=hik%24shipin7%231%23USK%23at.a2rwv07y6v44ozhqblhb0tly337hb4vq-4jktv8rbjh-193fe5b-cm38stbht", // 封面图片地址
                     "downloadPath": "218.244.139.5:0", //废弃
                     "type": 1 //废弃
                 },
                 {
                     "recType": 0,
                     "startTime": 1378345128000,
                     "endTime": 1378345128000,
                     "deviceSerial": "409864662",
                     "cameraNo": "1",
                     "localType": "ALLEVENT",
                     "channelType": "D",
                     "id": 20432171600,
                     "fileId": "20432171600",
                     "ownerId": "chenyong",
                     "fileType": 1,
                     "fileName": "",
                     "cloudType": 1,
                     "fileIndex": "5d5b6d94-13e8-440b-a25b-00eda521c35f",
                     "fileSize": 4011828,
                     "locked": 0,
                     "createTime": "2016-08-22 13:59:13",
                     "crypt": 22,
                     "keyChecksum": "",
                     "videoLong": 150000,
                     "coverPic": "https://218.244.139.5:0/api/cloud?method=download&fid=a14f8348-1dd1-11b2-aef9-dbed68cc4c3e&session=hik%24shipin7%231%23USK%23at.a2rwv07y6v44ozhqblhb0tly337hb4vq-4jktv8rbjh-193fe5b-cm38stbht",
                     "downloadPath": "218.244.139.5:0",
                     "type": 1
                 }
             }
         }
        

【海康云眸】API开发者 微信交流群

用微信扫右侧二维码,加入【海康云眸】API开发者 交流群,互助沟通

扫码加入交流群
上一页
UIKIT
下一页
Android
Built with