视频 WEB 插件开发指南
视频 WEB 插件开发指南
版权所有©杭州海康威视数字技术股份有限公司 2020
视频 WEB 插件开发指南
版权所有©杭州海康威视数字技术股份有限公司 2020。保留一切权利。
本文档的任何部分,包括文字、图片、图形等均归属于杭州海康威视数字技术股份有限公司或其关
联公司(以下简称“海康威视”)。未经书面许可,任何单位或个人不得以任何方式摘录、复制、翻
译、修改本手册的全部或部分。除非另有约定,海康威视不对本手册提供任何明示或默示的声明或
保证。
责任声明
在法律允许的最大范围内,本文档是“按照现状”提供,可能存在瑕疵或错误。海康威视不对本文档
提供任何形式的明示或默示保证,包括但不限于适销性、质量满意度、适合特定目的、不侵犯第三
方权利等保证;亦不对使用或是分发本文档导致的任何特殊、附带、偶然或间接的损害进行赔偿,
包括但不限于商业利润损失、系统故障、数据或文档丢失产生的损失。
视频 WEB 插件开发指南
目录
简介 ................................................................................................................................................................. 5
1.1 前言 ........................................................................................................................................................ 5
1.2 术语 ........................................................................................................................................................ 5
1.3 运行环境 ................................................................................................................................................ 3
1.4 约束说明 ................................................................................................................................................ 3
2. 版本更新 ................................................................................................................................................. 3
3. JS 接口说明 ............................................................................................................................................. 4
3.1 JS_STARTSERVICE 启动插件服务接口 ....................................................................................................... 4
3.2 JS_DISCONNECT 断开服务接口 ................................................................................................................. 5
3.3 JS_CREATEWND 创建插件窗口接口 ......................................................................................................... 5
3.4 JS_RESIZE 调整插件窗口大小、位置接口 .............................................................................................. 6
3.5 JS_CUTTINGPARTWINDOW 扣除部分插件窗口接口 .................................................................................. 6
3.6 JS_REPAIRPARTWINDOW 扣除插件窗口还原接口 ..................................................................................... 7
3.7 JS_HIDEWND 插件窗口隐藏接口 ............................................................................................................ 7
3.8 JS_SHOWWND 插件窗口显示接口 .......................................................................................................... 8
3.9 JS_DESTROYWND 插件窗口销毁接口 ....................................................................................................... 9
3.10 JS_WAKEUP 唤醒 WEBCONTROL.EXE 接口................................................................................................... 9
3.11 JS_SETDOCOFFSET 设置 IFRAME 偏移量接口 ........................................................................................... 10
3.12 JS_REQUESTINTERFACE 通用请求响应接口 .............................................................................................. 10
3.12.1
申请
RSA
公钥
.............................................................................................................................. 11
3.12.2
初始化
.......................................................................................................................................... 12
3.12.3
反初始化
...................................................................................................................................... 16
3.12.4
根据监控点编号视频预览
.......................................................................................................... 16
3.12.5
根据监控点编号录像回放
.......................................................................................................... 18
3.12.6
停止所有视频预览
...................................................................................................................... 20
3.12.7
停止所有录像回放
...................................................................................................................... 20
3.12.8
销毁播放实例
.............................................................................................................................. 21
3.12.9
获取当前布局
.............................................................................................................................. 21
3.12.10
设置当前布局
.......................................................................................................................... 22
3.12.11
播放抓图
.................................................................................................................................. 23
3.12.12
画面字符叠加
.......................................................................................................................... 24
3.12.13
根据监控点编号批量视频预览
.............................................................................................. 25
3.12.14
根据监控点编号批量录像回放
.............................................................................................. 26
3.12.15
批量停止播放
.......................................................................................................................... 28
3.12.16
设置接口认证信息参数
.......................................................................................................... 29
3.12.17
进入全屏
.................................................................................................................................. 30
3.12.18
退出全屏
.................................................................................................................................. 31
3.12.19
获取版本号
.............................................................................................................................. 31
3.12.20
设置时间轴级别
...................................................................................................................... 32
3.13 JS_SETWINDOWCONTROLCALLBACK 设置消息回调接口 ............................................................................ 33
视频 WEB 插件开发指南
3.13.1
窗口选中消息
.............................................................................................................................. 33
3.13.2
预览
/
回放播放消息
.................................................................................................................... 34
3.13.3
抓图结果消息
.............................................................................................................................. 35
3.13.4
预览紧急录像
/
回放录像剪辑结果消息
..................................................................................... 36
3.13.5
进入全屏
/
退出全屏消息
............................................................................................................. 36
3.13.6
切换布局消息
.............................................................................................................................. 37
3.13.7
播放窗口双击事件消息
.............................................................................................................. 37
3.13.8
时间轴级别变化消息
.................................................................................................................. 38
4. 视频 WEB 插件对接指南 ........................................................................................................................38
4.1 开发流程 .............................................................................................................................................. 38
4.2 网页开发指南 ...................................................................................................................................... 39
4.2.1
引用
JS
文件
................................................................................................................................. 39
4.2.2
创建
WebControl
实例
................................................................................................................. 40
4.2.3
启动插件
...................................................................................................................................... 40
4.2.4
监听事件
...................................................................................................................................... 41
4.2.5
申请
RSA
公钥
.............................................................................................................................. 42
4.2.6
插件初始化
.................................................................................................................................. 42
4.2.7
视频预览业务功能
...................................................................................................................... 43
4.2.8
断开插件服务连接
...................................................................................................................... 44
4.3 IFRAME 对接指南 ................................................................................................................................... 44
4.3.1 iframe demo
使用
............................................................................................................................. 44
4.3.2 iframe
对接步骤
............................................................................................................................... 44
5. 视频 WEB 插件 UI 集成控件列表 ...........................................................................................................45
6. 错误码定义 ............................................................................................................................................ 47
7. 附录 ........................................................................................................................................................48
7.1 如何获取 APPKEY 和 APPSECRET ............................................................................................................ 48
7.2 依赖 OPENAPI 接口汇总 ....................................................................................................................... 48
7.3 问题排查 .............................................................................................................................................. 48
视频 WEB 插件开发指南
简介
1.1 前言
非常感谢您使用我们公司的产品,我们将竭诚为您提供最好的服务。
本手册可能包含技术上不准确的地方或文字错误。
本手册的内容将做定期的更新,恕不另行通知,更新的内容将会在本手册的新版本中加入。
我们随时会改进或更新本手册中描述的产品或程序。
当您阅读该使用手册时,同时应该拿到本文档、以及以下文件:
表 1.1-1 文件清单
文件名称
描述
VideoWebPlugin.exe
视频 WEB 插件安装包
demo_window_integration.html
视频预览、回放全功能 Demo,可使用此 Demo 验证功能
demo_window_simple_preview.html
视频预览简化 Demo,可参照此 Demo 开发
demo_window_simple_playback.html
录像回放简化 Demo,可参照此 Demo 开发
demo_for_iframe.html
iframe 对接 demo,依赖 WEB 服务,请参照 iframe 对接指
南
demo_embedded_for_iframe.html
iframe 对接嵌入 html 文件,依赖 WEB 服务,请参照 iframe
对接指南
webs.exe
WEB 服务程序,请参照 iframe 对接指南
jsencrypt.min.js
用于 RSA 公钥加密的 js 库文件
jsWebControl-1.0.0.min.js
用于与视频 WEB 插件交互的 js 文件
1.2 术语
本文涉及相关术语如表 1.2-1 和图 1.2-1、图 1.2-2:
表 1.2-1 术语解释
名称
描述
视频 WEB 插件
视频 WEB 插件(以下简称 VideoWebPlugin)用于跨浏览器开发 WEB 视频应
用,提供了实时视频播放、历史视频回放功能。安装 VideoWebPlugin.exe 后,
系统会自动运行 WebControl.exe 的程序,并由 jsWebControl-1.0.0.min.js 与之交
互完成视频的各项功能
DIV 窗口
指前端提供的非弹出页面的 DIV 标识的窗口
插件窗口
指视频 WEB 插件提供的窗口,该窗口是 DIV 窗口的子窗口,若 DIV 窗口尺寸
发生变化,该窗口尺寸也随之变化。如图 1.2-1,整个图中的窗口称为插件窗口
插件服务
指管理插件窗口与 DIV 窗口交互、前端与视频 WEB 插件交付的服务,该服务
由 WebControl.exe 统一管理
评论10