Files
monibuca/dashboard/docs/plugins.md
2020-01-30 21:31:09 +08:00

104 lines
3.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 内置插件介绍
内置插件为Monibuca提供了许多基础功能当然你完全可以不采用内置插件而改用自己开发的插件也丝毫不会影响您使用Monibuca。
## Jessica插件
> 该插件源码位于plugins/jessica下
该插件为基于WebSocket协议传输音视频的订阅者音视频数据以裸数据的形式进行传输我们需要Jessibuca播放器来进行播放
Jessibua播放器已内置于源码中该播放器通过js解码H264/H265并用canvas进行渲染可以运行在几乎所有的终端浏览器上面。
在Monibuca的Web界面中预览功能就是使用的Jessibuca播放器。
### 配置
目前仅有的配置是监听的端口号
```toml
[Plugins.Jessica]
ListenAddr = ":8080"
```
### Flv格式支持
Jessica以及Jessibuca也支持采用WebSocket中传输Flv格式的方式进行通讯目前有部分CDN厂商已经支持这种方式进行传输。
>私有协议以及Flv格式的判断是通过URL后缀是否带有.flv来进行判断
## Rtmp插件
> 该插件源码位于plugins/rtmp下
实现了基本的rtmp传输协议包括接收来自OBS、ffmpeg等软件的推流以及来在Flash Player播放器的拉流。
### 配置
目前仅有的配置是监听的端口号
```toml
[Plugins.RTMP]
ListenAddr = ":1935"
```
## RecordFlv插件
> 该插件源码位于plugins/record下
实现了录制Flv文件的功能并且支持再次使用录制好的Flv文件作为发布者进行发布。在Monibuca的web界面的控制台中提供了对房间进行录制的操作按钮以及列出所有已经录制的文件的界面。
### 配置
配置中的Path 表示要保存的Flv文件的根路径可以使用相对路径或者绝对路径
```toml
[Plugins.RecordFlv]
Path="./resource"
```
## Http-Flv插件
> 该插件位于plugins/HDL下
实现了http-flv格式的拉流功能方便对接CDN厂商
### 配置
目前仅有的配置是监听的端口号
```toml
[Plugins.HDL]
ListenAddr = ":2020"
```
## Cluster插件
> 该插件源码位于plugins/cluster下
实现了基本的集群功能,里面包含一对发布者和订阅者,分别在主从服务器中启用,进行连接。
起基本原理就是在主服务器启动端口监听从服务器收到播放请求时如果从服务器没有对应的发布者则向主服务器发起请求主服务器收到来自从服务器的请求时将该请求作为一个订阅者。从服务器则把tcp连接作为发布者实现视频流的传递过程。
### 配置
主服务器的配置是ListenAddr用来监听从服务器的请求。
从服务器的配置是Master,表示主服务器的地址。
当然服务器可以既是主也是从,即充当中转站。
```toml
[Plugins.Cluster]
Master = "localhost:2019"
ListenAddr = ":2019"
```
## HLS插件
> 该插件源码位于plugins/HLS下
该插件的作用是请求M3u8文件进行解码最终将TS视频流转码成裸的视频流进行发布。
注意该插件目前并没有实现生成HLS的功能。
## 网关插件
> 该插件位于plugins/gateway下
该插件是为web控制台界面提供api用来采集服务器的信息。
### 配置
目前仅有的配置是监听的端口号
```toml
[Plugins.GateWay]
ListenAddr = ":80"
```
如果80端口有其他用途可以换成别的端口比如有nginx反向代理。
## 校验插件
> 该插件位于plugins/auth下
该插件提供了基本的验证功能,其原理是
订阅流提供一个签名签名只可以使用一次把签名进行AES CBC 解密如果得到的解密字符串的前面部分就是和Key相同则通过验证。
### 配置
Key代表用来加密的Key
```toml
[Plugins.Auth]
Key="www.monibuca.com"
```