Restful api + 视频播放插件说明文档

Restful api + 视频播放插件说明文档 renling2017/9/221使用场景12开发技能要求23运行环境要求24demo使用教程44.1 实时预览44.1.1加载控件，显示待预览页面44.1.2获取监控点编号54.1.3获取加密参数64.1.4视频播放84.2 云台控制94.3 回放104.3.1加载控件，显示待回放页面104.3.2录像回放114.4 结束OCX进程115协议文档125.1 OCX控件协议125.2 EXE弹出播放器协议145.3 云台控制协议146SDK调用接口167.FAQ（补充）171使用场景本文档是”restful api + 视频播放插件”说明文档。包括实时预览、云台控制、录像回放、结束OCX进程等功能，旨在提供功能演示操作和协议来帮助第三方更好地了解这些功能模块。本说明文档参数均通过在线调试获取。但在真实对接时,需要第三方通过https请求，参数从后台代码逻辑中获取。注：本文所提到的公网为部署在海康威视系统技术有限公司的环境（），内网为项目现场的环境，公网并不是项目现场映射的外网。2开发技能要求3运行环境要求a.安装视频播放插件：需要VideoClient（视频播放插件）为最新版，同时保证每一台客户机都要安装这个插件。如不确定，可在视频预览回放DEMO（源代码+使用文档）html-yyyymmdd.rar找到一个压缩包叫：视频播放插件_yyyymmdd.rar。压缩包解压到电脑上。双击“VideoClientSetup”，若之前安装过，会弹出下图对话框，点击“是”，可能会提醒需要手动删除一些内容，点击“确定”后，去上次安装的地方手动删除。注：以下图片请按从左à右，上à下的顺序观看。 手动删除后，再双击“VideoClientSetup”，点击“下一步”，选择您要安装的位置（示例中选择默认地址）后点击“下一步”； 可能会出现下左图对话框，提示“此文件夹已经存在，您一定要安装到这个文件夹中吗”，选择“是”即可，出现如下右图，再点击“下一步”，自由选择是否创建桌面快捷方式，再点击“下一步”。 点击“安装”，进度条会显示安装进度。 在进度条临近全满时，会提示修复C+程序，弹出“维护模式”对话框，选择“修复（R）”，点击下一步，修复后，会提示“安装完成”，点击“完成”，即完成安装。 b.检查浏览器环境：需要32位IE浏览器。如何查看浏览器位数?->打开IE浏览器,点击右上角设置按钮->找到“关于Internet explorer()”打开如下左图,无显示位数表示32位,否则会显示64位。图中为32位IE浏览器。 在步骤一中如控件无法加载,显示如上右图,漆黑一片。解决：打开Internet选项à安全à自定义级别,找到ActiveX控件和插件,选择启用,如下图。刷新页面，允许加载控件后，若颜色由黑色转为灰色则表示加载成功。4demo使用教程4.1实时预览4.1.1加载控件，显示待预览页面打开解压后的视频预览回放BS-DEMO（源代码+使用文档）html-2017xxxx.rar包，在文件夹“预览”下，双击playreal.html文件夹，允许运行ActiveX控件，如果控件仍然未加载出来，刷新页面或返回上述要求检查。加载后显示如下图后，表示加载成功，再进行下一节操作。序号变量名参数说明1ReqType请求类型。预览请求：ReqType:PlayReal；回放请求：ReqType:PlayBack2SvrIp & SvrPort 如果您是在公网环境对接,IP请输入”，port为”443”。如果您是现场环境对接，IP请由现场技术支持为您提供api接口的地址,端口现场默认为”9999”。3appKey公网对接：联系现场技术支持沟通海康研发为您开通；现场对接：现场技术支持提供。4appSecret提供appSecret明文，但须输入加密后的appSecret，即通过接口获取appSecret暗文。5time当前有效时间戳。精确到秒，示例:20170505145557。6TimeSecret当前加密时间戳。8httpsflag默认1。9CamList监控点列表，注：序号4,5,6参数获取详情见步骤二;序号9参数获取见步骤三4.1.2获取监控点编号a.若您是公网对接，请点击监控画面下方第一排的“去api网关”，或访问b.若您是内网对接，请访问https:/ip:9999/artemis/ 点击文档中心-通用服务。该步骤所需的appKey和appSecret请联系现场技术支持沟通海康研发为您提供。登录a或b的url后，选中API名称为“分页获取监控点信息”，点击，输入为您提供的appKey和appSecret。是否使用Mock请选择“否”。请求参数不填默认获取所有监控点位。得到与下图类似的返回结果。注：为避免在获取参数过程中超时，推荐先获取监控点位编号（CamList）。再获取appSecret、time、timeSecret参数值。如示例中，若要使用监控点“演示卡口-A”，注意：首先它得能进行预览和回放（8200平台查看），满足后，将indexCode中的值输入到CamList框中。或者,让海康技术支持提供一个能进行预览和回放的监控点位编号(indexCode)。4.1.3获取加密参数a.若您是公网对接，请点击监控画面下方第二排的“去api网关”，或访问b.若您是内网对接，请访问https:/ip:9999/artemis/ 点击文档中心-通用服务。该步骤同样需要为您提供的appKey和appSecret。登录a或b的url后，选择API名称为：根据appKey获取加密协议。点击，输入为您提供的appKey和appSecret。是否使用Mock请选择“否”。得到与下图类似的返回结果。 如上左图是调用“根据appKey获取加密协议”接口后的返回结果,右图是视频预览需要我们手动输入数据部分的截图,左图中用红框框中的部分，是我们需要填入右图的数据,请一一对应填入。注意：1：为您提供的是appSecret明文，但须输入调用接口加密后的appSecret，即上左图返回结果中的appsecret，不要输入我们直接为您提供的appSecret哦。2:用该html demo调试时，才可以使用该调试功能获取3个参数。真实对接时，需要通过后台代码逻辑，通过https请求,调用该API获得这3个参数。3：该三个参数的具有时效性，5分钟内有效。若该3个参数过了有效期，会提示“请求操作超时”。如下图。4.1.4视频播放按照4.1.2和4.1.3节，填入所有参数后，按照所需情况，点击或，稍等几秒，便会播放视频，如下两幅图，左图是点击“视频预览播放”效果，可以嵌入页面中，整合度较好；右图是点击“exe窗口”效果，是弹出一个独立的视频播放器，兼容性强,支持Chrome、Firefox、360等非IE浏览器。示例代码如下：以视频预览为例，在html添加相关的ocx标签，嵌套在div层里：弹出播放器模式的代码：4.2云台控制解压后，在文件夹“关闭进程 云台控制”下，双击ocxadvance.html文件夹，允许运行ActiveX控件，如果控件仍然未加载出来，刷新页面或返回要求检查。加载后显示如下图后，表示加载成功：appkey、appSecret、time、timeSecret、CamList的获取请参考实时预览demo下的4.1.2节和4.1.3节。填入无误后，点击“提交查询内容”。在下图红圈处,点击“上”、“下”、“左”、“右”，即可实现云台的上下左右控制操作。4.3回放4.3.1加载控件，显示待回放页面打开解压后的视频预览回放BS-DEMO（源代码+使用文档）html-20170908.rar包，在文件夹“回放”下，双击playback.html文件夹，允许运行ActiveX控件，如果控件仍然未加载出来，刷新页面或返回要求检查。加载后显示如下图后，表示加载成功，参数获取请参考4.1.2和4.1.3节。4.3.2录像回放所有参数都填入后，按照实际情况，点击或，稍等几秒，便会回放视频。如下两幅图，左图是点击“录像回放”效果，可以嵌入页面中，整合度较好；右图是点击“exe窗口”效果，是弹出一个独立的视频播放器，兼容性强,支持Chrome、Firefox、360等非IE浏览器。注意：如果start，end 时间不输入，默认查询的是当天0点到24点的录像。你也可以选择需要查询的录像时间段（前提需要确认能在8200平台查询到该监控点在该时段的录像）。4.4结束OCX进程点击，即可结束OCX进程。以下是结束OCX进程的代码：5协议文档5.1OCX控件协议平台播放器OCX协议，支持预览和回放两种模式。可在web面上嵌入ocx控件，整合度较好，但有浏览器限制只能使用IE8、9，IE11中可能会出问题（若出现问题，请尝试使用管理方式）。通过在web端根据协议规则拼装协议，将协议字符串写入html标签里调用方法。协议格式：变量均以分号“；”连接，用户可以根据自己的需求来追加协议，协议变量说明如下表格：序号变量名参数说明1ReqType请求类型：预览请求：ReqType:PlayReal回放请求：ReqType:PlayBack2SvrIp如果您是在公网环境对接,IP请输入“”。如果您是现场环境对接，IP请由现场技术支持为您提供api接口的地址。3SvrPort公网环境对接：port为“443”；现场环境对接：端口现场默认为”9999”。4AppKey公网对接：联系现场技术支持沟通海康研发为您开通；现场对接：现场技术支持提供。5AppSecret为您提供的appSecret通过加密后的暗文。6time当前有效时间戳。精确到秒，示例:20170505145557。7TimeSecret当前加密时间戳。8WndCount窗口数，支持1、4、9三种窗口模式。FAQ中有说明。9httpsflagvideoclient需