mirror of
https://github.com/Monibuca/plugin-rtmp.git
synced 2025-09-28 12:32:23 +08:00
docs: udpate readme
This commit is contained in:
39
README.md
39
README.md
@@ -39,35 +39,17 @@ ffplay -i rtmp://localhost/live/test
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
rtmp:
|
rtmp:
|
||||||
publish:
|
publish: # 参考全局配置格式
|
||||||
pubaudio: true # 是否发布音频流
|
subscribe: # 参考全局配置格式
|
||||||
pubvideo: true # 是否发布视频流
|
|
||||||
kickexist: false # 剔出已经存在的发布者,用于顶替原有发布者
|
|
||||||
publishtimeout: 10s # 发布流默认过期时间,超过该时间发布者没有恢复流将被删除
|
|
||||||
delayclosetimeout: 0 # 自动关闭触发后延迟的时间(期间内如果有新的订阅则取消触发关闭),0为关闭该功能,保持连接。
|
|
||||||
waitclosetimeout: 0 # 发布者断开后等待时间,超过该时间发布者没有恢复流将被删除,0为关闭该功能,由订阅者决定是否删除
|
|
||||||
buffertime: 0 # 缓存时间,用于时光回溯,0为关闭缓存
|
|
||||||
subscribe:
|
|
||||||
subaudio: true # 是否订阅音频流
|
|
||||||
subvideo: true # 是否订阅视频流
|
|
||||||
subaudioargname: ats # 订阅音频轨道参数名
|
|
||||||
subvideoargname: vts # 订阅视频轨道参数名
|
|
||||||
subdataargname: dts # 订阅数据轨道参数名
|
|
||||||
subaudiotracks: [] # 订阅音频轨道名称列表
|
|
||||||
subvideotracks: [] # 订阅视频轨道名称列表
|
|
||||||
submode: 0 # 订阅模式,0为跳帧追赶模式,1为不追赶(多用于录制),2为时光回溯模式
|
|
||||||
iframeonly: false # 只订阅关键帧
|
|
||||||
waittimeout: 10s # 等待发布者的超时时间,用于订阅尚未发布的流
|
|
||||||
tcp:
|
tcp:
|
||||||
listenaddr: :1935
|
listenaddr: :1935
|
||||||
|
listenaddrtls: "" # 用于RTMPS协议
|
||||||
|
certfile: ""
|
||||||
|
keyfile: ""
|
||||||
listennum: 0
|
listennum: 0
|
||||||
pull:
|
nodelay: false
|
||||||
repull: 0 # 当断开后是否自动重新拉流,0代表不进行重新拉流,-1代表无限次重新拉流
|
pull: # 格式参考文档 https://m7s.live/guide/config.html#%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE
|
||||||
pullonstart: {} # 是否在m7s启动的时候自动拉流
|
push: # 格式参考文档 https://m7s.live/guide/config.html#%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE
|
||||||
pullonsub: {} # 是否在有人订阅的时候自动拉流(按需拉流)
|
|
||||||
push:
|
|
||||||
repush: 0 # 当断开后是否自动重新推流,0代表不进行重新推流,-1代表无限次重新推流
|
|
||||||
pushlist: {} # 推流列表,以 streamPath为key,远程地址为value
|
|
||||||
chunksize: 65536 # rtmp chunk size
|
chunksize: 65536 # rtmp chunk size
|
||||||
keepalive: false #保持rtmp连接,默认随着stream的close而主动断开
|
keepalive: false #保持rtmp连接,默认随着stream的close而主动断开
|
||||||
```
|
```
|
||||||
@@ -81,8 +63,9 @@ subscribe
|
|||||||
### `rtmp/api/list`
|
### `rtmp/api/list`
|
||||||
获取所有rtmp流
|
获取所有rtmp流
|
||||||
|
|
||||||
### `rtmp/api/pull?target=[RTMP地址]&streamPath=[流标识]`
|
### `rtmp/api/pull?target=[RTMP地址]&streamPath=[流标识]&save=[0|1|2]`
|
||||||
从远程拉取rtmp到m7s中
|
从远程拉取rtmp到m7s中
|
||||||
|
- save含义:0、不保存;1、保存到pullonstart;2、保存到pullonsub
|
||||||
|
- RTMP地址需要进行urlencode 防止其中的特殊字符影响解析
|
||||||
### `rtmp/api/push?target=[RTMP地址]&streamPath=[流标识]`
|
### `rtmp/api/push?target=[RTMP地址]&streamPath=[流标识]`
|
||||||
将本地的流推送到远端
|
将本地的流推送到远端
|
Reference in New Issue
Block a user