Create README.md

Monibuca · Apr 8, 2022 · 6b82591 · 6b82591
1 parent 4a6823b
commit 6b82591
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# plugin-snap
+I帧截图插件
+
+# 安装
+1. 修改 Monibuca 项目中的 main.go ，在 import 里添加 `_ "github.com/Monibuca/plugin-snap/v3"`
+2. 修改 config.toml 添加 `[Snap]`
+
+# 接口
+`/api/snap?stream=视频流&timeout=超时毫秒`  
+
+视频流即流列表中的StreamPath，timeout默认超时2500毫秒，可以不传