linkingvision

Size: px

Start display at page:

Download "linkingvision"

路贡
5 years ago
Views:

2 版本记录版本日期描述 /04/03 第一个版本 /04/25 r4.2 h5stream 用户手册, 版本 1.00 页 2

3 h5stream 用户手册, 版本 1.00 页 3

4 内容 1.0 发布说明版本范围参考链接常用术语内容概述内网直播视频源支持运行平台支持直播协议支持视频加密支持云直播软件安装安装准备安装安装 license 配置视频源文件源配置 RTSP RTMP 源配置 ONVIF 源配置云推流模式配置云推流内网服务器配置 HTTP/HTTPS RESTFUL 接口协议格式系统视频源管理扩展 ONVIF 支持录像管理云推流管理 JS API 接口 JS 对象参数 Websocket WebRTC HLS RTMP h5stream 用户手册, 版本 1.00 页 4

5 1.0 发布说明 1.1 版本 1.00 初始版本. 2.0 范围文档包含 h5stream 互联网直播方案的使用场景, 安装指南, 开发接口定义和使用并介绍了各种浏览器在各个操作提供平台上使用的最佳直播方案, 从而可以实现低延迟视频直播 3.0 参考链接 ONVIF h5stream 用户手册, 版本 1.00 页 5

6 4.0 常用术语 h5stream 用户手册, 版本 1.00 页 6

5.0 内容概述近几年来, 互联网高速发展, 特别是移动互联网, 各种各样的移动 APP 都基于 HTML5 开发 FLASH 技术由于各种各样的问题, 浏览器开始停止支持, 但传统的安防厂家都还在使用 ActiveX 播放视频,ActiveX 目前只支持 IE, 所以如何支持在各种各样的浏览器和 APP 上支持无插件的非 FLASH 的视频播放变得非常重要浏览器原生播放视频的方法各有不同,

7 5.0 内容概述近几年来, 互联网高速发展, 特别是移动互联网, 各种各样的移动 APP 都基于 HTML5 开发 FLASH 技术由于各种各样的问题, 浏览器开始停止支持, 但传统的安防厂家都还在使用 ActiveX 播放视频,ActiveX 目前只支持 IE, 所以如何支持在各种各样的浏览器和 APP 上支持无插件的非 FLASH 的视频播放变得非常重要浏览器原生播放视频的方法各有不同, 安防直播有个基本的要求就是低延迟, 需要延迟控制在 1 秒以内或者 500 毫秒以内这对 HTML5 视频直播技术带来很大的挑战随着云技术的普及, 视频远程播放, 远程分享也非常重要 H5STREAM 解决了 HTML5 原生视频和云视频直播问题,H5STREAM 支持 WEBRTC WEBSOCKET HLS RTMP 播放技术, 下表列举了各种浏览器支持的技术浏览器兼容技术 h5stream 用户手册, 版本 1.00 页 7

8 6.0 内网直播 H5STREAM 是一个支持 Windows Linux(CentOS ubuntu) macos 的直播平台内网直播 6.1 视频源支持 H5STREAM 支持将 MP4/AVI 文件做为视频源从而给用户测试带来很大的方便目前视频监控摄像机都支持 RTSP, 现在 RTMP 还有一定的市场占有率,H5STREAM 很好的支持 RTSP/RTMP 作为视频监控的标准 ONIVF,H5STREAM 也做了支持, 并且允许用户 RESTFUL 接口控制 ONIVF 云台 6.2 运行平台支持 H5STREAM 是一个跨平台的流媒体系统支持多种操作系统部署, 包括 Windows 7/8/10, CentOS ubuntu macos, 并且可以将 H5STREAM 运行在阿里云或者亚马逊 AWS 如果用户量比较大, 还可以基于 NGINX 部署流媒体集群 6.3 直播协议支持 RTMP/RTSP/HLS 是目前比较传统的流媒体协议, 在 H5STREAM 中有很好的支持, 新兴的 h5stream 用户手册, 版本 1.00 页 8

9 WEBSOCKET 和 WEBRTC 也在 H5STREAM 得到很好的支持, 从而可以高性能的解码和获得超低的延迟 6.4 视频加密支持 H5STREAM 支持在浏览器上无插件播放视频的同时, 所有的视频数据都会采用非对称加密, 充分保证的视频数据的安全 h5stream 用户手册, 版本 1.00 页 9

10 7.0 云直播如果用户需要远程访问直播视频, 如果使用传统的 NAT 端口映射或 DDNS, 既麻烦又不安全, H5STREAM 支持云推流的模式, 并且所有码流全部加密, 从而保证了通信安全云直播 h5stream 用户手册, 版本 1.00 页 10

11 8.0 软件安装 8.1 安装准备 8.2 安装准备 Windows 7/8/10 Centos ubuntu macos 32 位 ( 只支持 Windows)/64 位操作系统, 4G 内存 1 核 CPU 及以上下载安装包从如下链接中下载对应的安装包安装 Windows vs2017 运行支持包 32 位 17bf10f2d56d60fcba6ab1/VC_redist.x86.exe 64 位 c7b206ad10373cbca89b/vc_redist.x64.exe 手工运行解压产品包, 并运行 h5ss.bat h5stream 用户手册, 版本 1.00 页 11

12 产品发布包目录安装为服务 Windows 可以直接运行 regservice.bat 安装服务或者运行 unregservice.bat 取消安装服务 Centos 7 拷贝发布包到 /opt/h5ss cp h5ss.service /usr/lib/systemd/system/ systemctl enable h5ss.service systemctl start h5ss.service h5stream 用户手册, 版本 1.00 页 12

13 Ubuntu sudo mkdir -p /usr/lib/systemd/system/ sudo apt install systemd 拷贝发布包到 /opt/h5ss cp h5ss.service /usr/lib/systemd/system/ systemctl enable h5ss.service systemctl start h5ss.service 8.3 安装 license 在 logs/h5sslog.log 中获取 Hostid, 让后把 Hostid 发送给等收到 h5ss.lic license 文件后, 把 h5ss.lic 文件放到 conf 目录下, 然后重新启动 h5ss 即可 h5stream 用户手册, 版本 1.00 页 13

14 9.0 配置视频源在程序发布包里有个 conf/h5ss.conf 文件, 可以修改配置完成视频源配置, 当然也可以参考 RESTFUL 接口使用 API 进行配置修改下表列举了所有的配置项配置文件介绍 9.1 文件源配置在视频源配置中,strToken 是视频源的唯一标识, 请保持多视频源时该字符串不要相同在配置文件中修改 ntype 为 H_FILE, strurl 视频文件路径, 官方网站提供了测试视频源可以下载到本地文件源配置 h5stream 用户手册, 版本 1.00 页 14

15 修改好配置文件, 重新启动 h5ss.bat, 在 Chrome 中输入或者由于 HTTPS 服务器的证书是自搬的, 需要点击前往 HTTP 视频访问 HTTPS 视频访问 9.2 RTSP RTMP 源配置在配置文件中把 ntype 修改为 H5_STREAM, 在 strurl 部分填入 RTSP RTMP 地址, 对于需要 h5stream 用户手册, 版本 1.00 页 15

16 认证的 RTSP 源, 需要在 struser 和 strpasswd 中填入对应的用户名密码 RTSP 地址中内嵌的用户名密码将不会生效 RTSP/RTMP 源配置 9.3 ONVIF 源配置 ONVIF 配置选项比较多, 但是大部分都可以采用默认配置, 可以只关注下图中标注的部分 ntype 修改为 H5_ONVIF, 配置 ONIVF 用户名密码,ONIVF 设备地址和端口即可 ONVIF 源配置 h5stream 用户手册, 版本 1.00 页 16

17 10.0 云推流模式配置 10.1 云推流内网服务器配置在配置文件中找到 cloud 部分, 需要开启云模式, 并且配置一下端口, 是否是 HTTPS, 用户名和密码可以参考下图的配置 : h5stream 用户手册, 版本 1.00 页 17

18 11.0 HTTP/HTTPS RESTFUL 接口 RESTFUL 接口是基于 HTTP 的简单的无状态的协议, 所有的请求采取 GET 方法,HTTP 返回都采用 JSON 格式. 调试的时候可以使用 HTTP, 在实际的生产环境中建议使用 HTTPS 为了方便后续的例子都是用 HTTP, 如果换 HTTPS, 只需要把对应的 http 换成 https 即可 11.1 协议格式所有的请求都采用 HTTP GET, 返回采用 JSON 格式, 具体返回的 JSON 格式根据不同的命令而不同, 下表是基本的格式和例子, 为了让大家更容易理解, 有些命令介绍中直接使用代表性的值格式 : Request : &< >=< > "bstatus": true/false, "strcode": "xxxxxx" \r\n < >=< > 代表多个请求参数. 例子 : Request : min&password=12345&ip= &port=80&onvifaddr=/onvif/device_serv ice&session=c1782caf-b670-42d8-ba d0b0ee83 "bstatus": true, "strcode": "Add successfully" \r\n h5stream 用户手册, 版本 1.00 页 18

19 11.2 系统登录 URL: /api/v1/login 安全级别 : Administrator, Operator, Viewer Request : "bstatus": true, "strsession": "c1782caf-b670-42d8-ba d0b0ee83", "ntimeout": 600 or "bstatus": false, "strcode": "xxxxxx" \r\n 参数是否可选描述 user 必须用户名默认为 admin password 必须密码默认为登出 URL: /api/v1/logout 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 19

20 Request : "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述保活 URL: /api/v1/keepalive 安全级别 : Administrator, Operator, Viewer Request : "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述获取系统信息 URL: /api/v1/getsysteminfo h5stream 用户手册, 版本 1.00 页 20

21 安全级别 : Administrator, Operator, Viewer Request : "strversion": "r ", "strhostid": "xxxxxxxxx", "strlicensetype": "None", "strlicensefull": "", "strchannellimit": "unlimited", "strendtime": "unlimited" \r\n 参数是否可选描述获取运行信息 URL: /api/v1/getruninfo 安全级别 : Administrator, Operator, Viewer Request : "strruntime": "0H 23MIN", "strcpu": "16%", "strmemory": "39%", "strnetworkin": "0kpbs", "strnetworkout": "0kpbs" \r\n h5stream 用户手册, 版本 1.00 页 21

22 参数是否可选描述更改用户名密码 URL: /api/v1/ UpdateUser 安全级别 : Administrator, Operator, Viewer Request : UpdateUser?user=admin&oldpassword=827ccb0eea8a706c4c34a16891f84e7b&newpa ssword=xxxxxx&session=xxxxxx "bstatus": true, "strcode": "Update user successfully" \r\n 参数是否可选描述 user 必须 user name oldpassword 必须原来的密码 (MD5) newpassword 必须新的密码 (MD5) h5stream 用户手册, 版本 1.00 页 22

23 11.3 视频源管理获取源列表 URL: /api/v1/getsrc 安全级别 : Administrator, Operator, Viewer Request : "src": [ "ntype": "H5_ONVIF", "strname": "name1", "strtoken": "token1", "strurl": "rtsp:// /stream", "struser": "admin", "strpasswd": "******", "bpasswdencrypt": false, "benableaudio": false, "nconnecttype": "H5_AUTO", "nrtsptype": "H5_RTSP_AUTO", "strsrcipaddress": " ", "strsrcport": "80", "nchannelnumber": 1, "bonvifprofileauto": true, "stronvifaddr": "/onvif/device_service", "stronvifprofilemain": "Profile_1", "stronvifprofilesub": "Profile_2", "bonline": true, "strsnapshoturl": "/api/v1/getimage?token=token1", "strservertoken": "",// 该 token 为对应注册的 h5stream token "stroriginaltoken": "" ] 参数是否可选描述 token 可选获取源的 token, 如果空表示所有 h5stream 用户手册, 版本 1.00 页 23

24 添加文件源 URL: /api/v1/addsrcfile 安全级别 : Administrator, Operator, Viewer Request : AddSrcFile?name=xxx&token=xxx&url=xxx&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须添加源的 token name 必须该源的名字 url 必须文件在服务器上路径, 路径需要转义, 可以使用在线转义工具 C:\xdev\h5s-r win64- release\h5ssample.mp4 转义成 : C%3a%5cxdev%5ch5s-r win64- release%5ch5ssample.mp4 servertoken 可选添加到注册的 h5stream( 下个版本 ) 添加后该源的 token 会映射一个新的 token, 需要重新 GetSrc 获取 h5stream 用户手册, 版本 1.00 页 24

25 添加 RTSP RTMP 源 URL: /api/v1/addsrcrtsp 安全级别 : Administrator, Operator, Viewer Request : &user=admin&password=12345&url=rtsp:// /stream&session=x xxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n h5stream 用户手册, 版本 1.00 页 25

26 参数是否可选描述 token 必须添加源的 token name 必须该源的名字 user 可选 RTSP 用户名 password 必须 RTSP 密码 url 必须 RTSP RTMP 地址需要转义, 可以使用在线转义工具 rtsp:// :554/streaming/channels/101?transportmode=unicast&profile=profile_1 转义成 : rtsp%3a%2f%2f %3a554%2fstreaming %2fChannels%2f101%3ftransportmode%3dunicast %26profile%3dProfile_1 servertoken 可选添加到注册的 h5stream( 下个版本 ) 添加 ONVIF 源 URL: /api/v1/addsrconvif 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 26

27 Request : &user=admin&password=12345&ip= &port=80&onvifaddr=/onvif/device_service&main=profile_1&sub=profile_2&se ssion=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" 参数是否可选描述 token 必须添加源的 token name 必须该源的名字 user 必须 ONVIF 用户名 password 必须 ONVIF 密码 ip 必须 ONVIF 设备地址 port 必须 ONVIF 设备端口 onvifaddr 可选 ONIVF 服务地址, 默认 /onvif/device_service main 可选主码流 token sub 可选辅码流 token servertoken 可选添加到注册的 h5stream( 下个版本 ) 删除源 URL: /api/v1/delsrc 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 27

28 Request : "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须删除源云台操作 URL: /api/v1/ptz 安全级别 : Administrator, Operator, Viewer Request : Ptz?token=token1&action=left&speed=0.5&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n h5stream 用户手册, 版本 1.00 页 28

29 参数是否可选描述 token 必须 ONIVF 视频源 token action 必须云台指令 up/down/left/right/ zoomin/zoomout/stop / preset speed 可选 stop 指令可以不带 speed 范围为 0-1 可以是小数 preset 可选指定的预置点设置预置点 URL: /api/v1/ SetPreset 安全级别 : Administrator, Operator, Viewer Request : SetPreset?token=token1& &presetname=2&presettoken=2&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n h5stream 用户手册, 版本 1.00 页 29

30 参数是否可选描述 token 必须 ONIVF 视频源 token presetname 必须 preset 名字比如 1,2,3 presettoken 必须 preset token 比如 1,2, 删除预置点 URL: /api/v1/ DelPreset 安全级别 : Administrator, Operator, Viewer Request : DelPreset?token=token1& & presettoken=2&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须 ONIVF 视频源 token presettoken 必须 preset token 比如 1,2, 扩展 ONVIF 支持搜索 ONVIF 设备 URL: /api/v1/onvifsearch h5stream 用户手册, 版本 1.00 页 30

31 安全级别 : Administrator, Operator, Viewer Request : "device": [ "strip": " ", "strport": "80", "stronvifaddr": "/onvif/device_service", "strmodel": "xxx-xxx" ] 参数是否可选描述 timeout 可选搜索时长, 单位是秒默认 10 秒 servertoken 可选在注册的 h5stream 搜索 ( 下个版本 ) 探测 ONVIF 设备 URL: /api/v1/onvifprobe 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 31

32 Request : OnvifProbe?ip= &port=80&user=admin&password=12345&onvifaddr=/o nvif/device_service&session=xxxxxx "profile": [ "strtoken": "Profile_1", "strcodecname": "H264", "strname": "H x fps 3072bps", "strrtspurl": "rtsp:// :554/streaming/channels/101?transportmode=unicast&pr ofile=profile_1", "nwidth": 1920, "nheight": 1080, "nfps": 25, "nbandwidth": 0, "bgoturl": true ] Or "bstatus": false, "strcode": "can't connect device" 参数是否可选描述 user 必须 ONVIF 设备用户名 password 必须 ONVIF 设备密码 ip 必须 ONVIF 设备 IP 地址 port 必须 ONVIF 设备端口 onvifaddr 可选 ONVIF 服务地址 servertoken 可选在注册的 h5stream 探测 ( 下个版本 ) h5stream 用户手册, 版本 1.00 页 32

33 11.5 录像管理录像 URL: /api/v1/record 安全级别 : Administrator, Operator, Viewer Request : xxxxx&&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须视频源 token duration 必须录像时长 filename 可选录像文件名, 如果空, 自动生成文件名, 文件名不用带文件扩展指定路径录像 URL: /api/v1/pathrecord 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 33

34 Request : 29&start2=3-3-5&duration=100&tz=8&filename=xxxxx&&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须视频源 token duration 必须录像时长 start1 必须开始时间年 - 月 - 日 start2 必须开始时间小时 - 分钟 - 秒可以按下面路径直接访问录像 /mediastore/record/token1/ tz8/ /filename.mp4 tz 可选 8 或者 -8, 如果没有此参数默认使用服务器所在的时区 filename 必须录像文件名, 文件名不用带文件扩展快照 URL: /api/v1/snapshot 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 34

35 Request : Snapshot?token=token1&filename=xxxxx&&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n 参数是否可选描述 token 必须视频源 token filename 可选快照文件名, 如果空, 自动生成文件名, 文件名不用带文件扩展按路径快照 URL: /api/v1/pathsnapshot 安全级别 : Administrator, Operator, Viewer Request : PathSnapshot?token=token1&start1= &start2=3-3-5&tz=8&filename=xxxxx&&session=xxxxxx "bstatus": true/false, "strcode": "xxxxxx" \r\n h5stream 用户手册, 版本 1.00 页 35

36 参数是否可选描述 token 必须视频源 token start1 必须开始时间年 - 月 - 日 start2 必须开始时间小时 - 分钟 - 秒可以按下面路径直接访问快照 /mediastore/snapshot/token1/ TZ8/ /filename.jpg tz 可选 8 或者 -8, 如果没有此参数默认使用服务器所在的时区 filename 必须快照文件名, 文件名不用带文件扩展搜索 URL: /api/v1/search 安全级别 : Administrator, Operator, Viewer h5stream 用户手册, 版本 1.00 页 36

37 Request : Search?type=xxx&start= T120101%2b08&end= T130101%2b08&token=xxx&session=xxxxxx "record": [ "strtoken": "token1", "strstarttime": " T19:32:05+08:00", "strduration": "301", "strpath": "/mediastore/record/token1/ tz8/ /1234.mp4", "strtoken": "token1", "strstarttime": " T19:37:05+08:00", "strduration": "0", "strpath": "/mediastore/record/token1/ tz8/ /1234.mp4" ] \r\n 参数是否可选描述 token 必须视频源 token type 必须 record 或者 snapshot start 必须 ISO8601 格式时间 T end 必须 ISO8601 格式时间 T 云推流管理本地端注册信息获取 URL: /api/v1/getcloudclientinfo 用于获取内网 H5Stream 注册状态 h5stream 用户手册, 版本 1.00 页 37

38 安全级别 : Administrator, Operator, Viewer Request : GetCloudClientInfo&session=xxxxxx "benable": true, "strservername": "Server 1", "strcloudip": " ", "strcloudport": "8080", "bssl": false, "struser": "admin", "bonline": true \r\n 参数是否可选描述云端注册 Server 获取 URL: /api/v1/ GetServerList 用于获取云端注册上的 H5Stream server 列表安全级别 : Administrator, Operator, Viewer Request : "server": [ "strservertoken": "fc2f0aa4-86ca-4d75-ad29-59b91326dfae", "strserverip": " ", "bonline": true ] \r\n h5stream 用户手册, 版本 1.00 页 38

39 参数是否可选描述 h5stream 用户手册, 版本 1.00 页 39

40 12.0 JS API 接口 12.1 JS 对象参数 var conf = videoid:'h5svideo1', //string - id of the video element tag videodom: h5svideodom1, //object - video dom. if there has videoid, just use the videoid protocol: window.location.protocol, // string - http: or https: host: window.location.host, //string - localhost:8080 rootpath:window.location.pathname, // string - path of the app running token:'token1', // string - token of stream hlsver:'v1', //string - v1 is for ts, v2 is for fmp4 session:'c1782caf-b670-42d8-ba d0b0ee83' //string - session got from login ; */ 12.2 Websocket /** * Interface with h5s websocket player API */ function H5sPlayerWS(conf) H5sPlayerWS.prototype.connect H5sPlayerWS.prototype.disconnect 12.3 WebRTC /** * Interface with h5s WebRTC player API */ function H5sPlayerRTC(conf) H5sPlayerRTC.prototype.connect H5sPlayerRTC.prototype.disconnect 12.4 HLS h5stream 用户手册, 版本 1.00 页 40

41 /** * Interface with h5s websocket player API */ function H5sPlayerHls(conf) H5sPlayerHls.prototype.connect H5sPlayerHls.prototype.disconnect 12.5 RTMP 为了支持老版本的一些浏览器,H5Stream 支持基于 Flash 的 RTMP 视频播放采用的播放器是 videojs, 具体使用方法可以参考 www/rtmp.html h5stream 用户手册, 版本 1.00 页 41