Monibuca

Appearance

RECORD 插件 ​

对流进行录制的功能插件，提供 Flv、fmp4、hls、裸流格式的录制功能。

插件地址 ​

https://github.com/Monibuca/plugin-record

插件引入 ​

go
import _ "m7s.live/plugin/record/v4"

配置 ​

  • 配置中的 path 表示要保存的文件的根路径，可以使用相对路径或者绝对路径
  • filter 代表要过滤的 StreamPath 正则表达式，如果不匹配，则表示不录制。为空代表不进行过滤
  • fragment 表示分片大小（秒），0 代表不分片
yaml
record:
  subscribe:
    subaudio: true # 是否订阅音频流
    subvideo: true # 是否订阅视频流
    subaudioargname: ats # 订阅音频轨道参数名
    subvideoargname: vts # 订阅视频轨道参数名
    subdataargname: dts # 订阅数据轨道参数名
    subaudiotracks: [] # 订阅音频轨道名称列表
    subvideotracks: [] # 订阅视频轨道名称列表
    submode: 0 # 订阅模式，0为跳帧追赶模式，1为不追赶（多用于录制），2为时光回溯模式
    syncmode: 0 # 音视频同步模式，0 为按照时间戳同步，1 为按照写入时间同步
    iframeonly: false # 只订阅关键帧
    waittimeout: 10s # 等待发布者的超时时间，用于订阅尚未发布的流
    writebuffersize: 0 # 订阅者写缓存大小，用于减少io次数，但可能影响实时性
    key: "" # 订阅者鉴权秘钥
    secretargname: secret # 订阅者鉴权参数名
    expireargname: expire # 订阅者鉴权过期时间参数名
    internal: false # 是否内部订阅，内部订阅不会触发发布者自动断开功能
  flv:
    ext: .flv
    path: record/flv
    autorecord: false
    filter: ""
    fragment: 0
  fmp4:
    ext: .mp4
    path: record/fmp4
    autorecord: false
    filter: ""
    fragment: 0
  mp4:
    ext: .mp4
    path: record/mp4
    autorecord: false
    filter: ""
    fragment: 0
  hls:
    ext: .m3u8
    path: record/hls
    autorecord: false
    filter: ""
    fragment: 0
  raw:
    ext: .
    path: record/raw
    autorecord: false
    filter: ""
    fragment: 0

接口 API ​

罗列所有正在录制中的流的信息 ​

  • URL: /record/api/list/recording
  • 请求方式: GET

罗列所有录制的文件 ​

  • URL: /record/api/list
  • 请求方式: GET
  • 参数:
参数名必填类型描述
type是string文件类型， flv 、 fmp4 、 hls
  • 示例:
    • /record/api/list?type=flv
    • /record/api/list?type=fmp4

开始录制某个流 ​

  • URL: /record/api/start
  • 请求方式: GET
  • 返回: 返回一个字符串用于停止录制用的 id
  • 参数:
参数名必填类型描述
type是string文件类型， flv 、 fmp4 、 hls
streamPath是string流地址， 默认是 live/rtc
fileName否string文件名字
fragment否string切片名字

fileName 是可选的，且只用于非切片情况,fragment 也是可选的,如果 fileName 和 fragment 都存在，则忽略 fileName

  • 示例:
    • /record/api/start?type=flv&streamPath=live/rtc&fileName=xxx&fragment=xxx

停止录制某个流 ​

  • URL: /record/api/stop
  • 请求方式: GET
  • 参数:
参数名必填类型描述
id是stringstart 接口返回的 id 值
  • 示例:
    • /record/api/stop?id=xxx

点播功能 ​

访问格式：

sh
[http/https]://[host]:[port]/record/[streamPath].[flv|mp4|m3u8|h264|h265]

例如：

  • http://localhost:8080/record/live/test.flv 将会读取对应的 flv 文件
  • http://localhost:8080/record/live/test.mp4 将会读取对应的 fmp4 文件