zishuo/ipchub
1
0
Fork 0
mirror of https://github.com/cnotch/ipchub.git synced 2025-09-26 19:41:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
notch
2020-12-31 10:40:34 +08:00
parent 21feca0206
commit aedd437a52
2 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/config.md
View File

@@ -1,4 +1,4 @@
## 1. 跟配置
## 1. 根配置对象
属性 | 说明 | 示例
-|-|-
listen | 侦听地址，":1554" | 默认：":1554" |
@@ -23,7 +23,7 @@ key | 私钥内容或文件 | |
属性 | 说明 | 示例
-|-|-
pattern | 本地路径模式字串 | 当以'/'结尾，表示一个以pattern开头的请求都路由到下面的url |
url | 路由的目标地址，用户名和密码可以直接写在url中 | rtsp://admin@adminlocalhost/live2 |
url | 路由的目标地址，用户名和密码可以直接写在url中 | rtsp://admin:admin@localhost/live2 |
keepalive | 是否保持连接；如果没有消费者是否继续保持连接，如果为false在5分钟后自动断开 | false/true |
### 3.1 pattern

36
docs/quickstart.md
View File

@@ -20,6 +20,7 @@
}
]
```
我们配置了两个路由：
+ /group/door : 集团大门直接连接到摄像头
+ /hr/ : 人力资源部门的摄像头路由到下级的服务器
@@ -33,7 +34,7 @@
+ websocket-flv
+ http-hls
下面我们分别使用不同的方式访问上面两个路由的摄像头
下面我们分别使用不同的方式访问上面两个路由的摄像头。
### 3.1 使用rtsp访问
```
@@ -41,42 +42,49 @@ ffplay -rtsp_transport tcp rtsp://localhost:1554/group/door -fflags nobuffer
ffplay -rtsp_transport udp rtsp://localhost:1554/group/door -fflags nobuffer
ffplay -rtsp_transport udp_multicast rtsp://localhost:1554/group/door -fflags nobuffer
```
上面分别使用了 TCP、UDP、multicast 等三种方式访问
要访问hr的/door/video1，只要将/group/door换成/hr/door/video1即可
上面分别使用了 TCP、UDP、multicast 等三种 rtsp 播放模式。
要访问hr的/door/video1，只要将/group/door换成/hr/door/video1即可。
```
ffplay -rtsp_transport tcp rtsp://localhost:1554/hr/door/video1 -fflags nobuffer
```
rtsp://localhost:1554/hr/door/video1 请求在服务器内自动变成去拉取rtsp://admin:admin@192.168.110.145:1554/door/video1
rtsp://localhost:1554/hr/door/video1 请求在服务器内自动变成去拉取rtsp://admin:admin@192.168.110.145:1554/door/video1。
### 3.2 使用websocket-rtsp
打开demo地址：http://localhost:1554/demos/rtsp
输入：ws://localhost:1554/ws/group/door 即可访问
输入：ws://localhost:1554/ws/group/door 即可访问。
### 3.3 使用http-flv访问
打开demo地址：http://localhost:1554/demos/flv
输入：http://locaolhost:1554/streams/group/door.flv 即可访问
由于 Chrome 对长连接的流限制为6个，因此如果使用 Chrome 打开更多建议使用websocket-flv
输入：http://locaolhost:1554/streams/group/door.flv 即可访问。
**注意：**由于 Chrome 对长连接的流限制为6个，因此如果使用 Chrome 打开更多建议使用websocket-flv。
### 3.4 使用 websocket-flv访问
打开demo地址：http://localhost:1554/demos/flv
输入：ws://locaolhost:1554/ws/group/door.flv 即可访问
输入：ws://locaolhost:1554/ws/group/door.flv 即可访问。
### 3.5 使用 http-hls访问
由于 iOS的Safari不支持上述任何http访问模式，请使用 http-hls
在浏览器输入: http://localhost:1554/streams/group/door.m3m8 即可访问
在浏览器输入: http://localhost:1554/streams/group/door.m3m8 即可访问。
**注意:** 由于http-hls的段文件默认被放在内存中，占用大量的内存；如系统内存不足，请配置存储路径。
## 4. 需要授权的情况
除rtsp外，其他使用token进行访问
除rtsp外，其他使用token进行访问。
如果 http-flv,
输入：http://locaolhost:1554/streams/group/door.flv?token=7f97509e321a18ccf281607f4c0bd4fb
其中 token 通过登录api获得
相关信息请参考[配置文档](config.md) 和 [Api 文档](apis.md)
其中 token 通过登录api获得的相关信息请参考[配置文档](config.md) 和 [Api 文档](apis.md)。
## 5. 浏览器支持情况
http-flv、websocket-flv等浏览器访问，支持：
http-flv、websocket-flv、websocket-rtsp等浏览器访问，支持：
+ Firefox v.42+
+ Chrome v.23+
+ OSX Safari v.8+
@@ -85,4 +93,4 @@ http-flv、websocket-flv等浏览器访问，支持：
+ Android browser v.5.0+
+ IE Mobile v.11+
不支持 iOS Safari 和 IE
不支持 iOS Safari 和 IE。