From fa59cc004ea6bca5dd5e6e6f85b7aac0f5025281 Mon Sep 17 00:00:00 2001 From: langhuihui <178529795@qq.com> Date: Wed, 17 May 2023 08:05:12 +0800 Subject: [PATCH] update readme --- README.en.md | 12 +++++++++++- README.md | 12 +++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.en.md b/README.en.md index 90dc254..c764964 100644 --- a/README.en.md +++ b/README.en.md @@ -17,6 +17,8 @@ https://github.com/Monibuca/plugin-ps ```yaml ps: + http: # format refer to global config + publish: # format refer to global config publish: # format refer to global config relaymode: 1 # 0:relay only 1:protocol transfar only 2:relay and protocol transfar ``` @@ -32,4 +34,12 @@ ps: `/ps/api/replay?streamPath=xxx&dump=xxx` - dump means the file to replay, default is dump/ps -- streamPath means the streamPath of replayed video stream, default is replay/dump/ps (if dump is abc, then streamPath is replay/abc) \ No newline at end of file +- streamPath means the streamPath of replayed video stream, default is replay/dump/ps (if dump is abc, then streamPath is replay/abc) + +### read PS stream by ws protocol + +`ws://[host]/ps/[streamPath]` + +for example: ws://localhost:8080/ps/live/test + +the data is raw PS data, without rtp header \ No newline at end of file diff --git a/README.md b/README.md index 057068a..8c7e0f8 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,9 @@ https://github.com/Monibuca/plugin-ps ```yaml ps: + http: # 格式参考全局配置 publish: # 格式参考全局配置 + subscribe: # 格式参考全局配置 relaymode: 1 # 0:纯转发 1:转协议,不转发 2:转发并且转协议 ``` @@ -31,4 +33,12 @@ ps: `/ps/api/replay?streamPath=xxx&dump=xxx` - dump 代表需要回放的文件,默认是dump/ps -- streamPath 代表回放时生成的视频流的streamPath, 默认是replay/dump/ps (如果dump传了abc, 那么streamPath默认是replay/abc) \ No newline at end of file +- streamPath 代表回放时生成的视频流的streamPath, 默认是replay/dump/ps (如果dump传了abc, 那么streamPath默认是replay/abc) + +### 以ws协议读取PS流 + +`ws://[host]/ps/[streamPath]` + +例如: ws://localhost:8080/ps/live/test + +数据包含的是裸的PS数据,不包含rtp头 \ No newline at end of file