Monibuca

Appearance

HLS 插件 ​

该插件可用来拉取网络上的 m3u8 文件并解析后转换成其他协议

  • 可以直接访问http://localhost:8080/hls/live/user1.m3u8 进行播放，其中 8080 端口是全局 HTTP 配置，live/user1 是 streamPath，需要根据实际情况修改
  • llhls 地址形式http://localhost:8080/llhls/live/user1/index.m3u8 进行播放，其中 8080 端口是全局 HTTP 配置，live/user1 是 streamPath，需要根据实际情况修改

插件地址 ​

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

插件引入 ​

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

接口 API ​

获取所有 HLS 流 ​

  • URL: /hls/api/list
  • 请求方式: GET
  • 描述: 列出所有 HLS 流，该接口是一个 Server-Sent Events (SSE)，可以持续接收到列表数据。
  • 参数:
参数名必填类型描述
json否string可选参数，设置 1 ，则返回的数据将以 JSON 格式呈现
  • 示例:
    • /hls/api/list
    • /hls/api/list?json=1

保存指定的流为 HLS 文件 ​

  • URL: /hls/api/save
  • 请求方式: GET
  • 描述: 保存指定的流为 HLS 文件（m3u8 和 ts）。当请求关闭时，保存过程将结束。该 API 仅作用于远程拉流。
  • 参数:
参数名必填类型描述
streamPath是string指定要保存的流路径，例如 live/hls
  • 示例:
    • /hls/api/save?streamPath=live/hls

拉取目标 HLS 流作为媒体源 ​

  • URL: /hls/api/pull
  • 请求方式: GET
  • 描述: 将目标 HLS 流拉取过来，作为媒体源在 Monibuca 内以指定流路径的形式存在。
  • 参数:
参数名必填类型描述
streamPath是string指定在 Monibuca 内的流路径，例如 live/hls
target是string指定目标 HLS 流的 URL，例如 http://localhost/abc.m3uo8
  • 示例:
    • /hls/api/pull?streamPath=live/hls&target=http://localhost/abc.m3u8

配置 ​

  • 配置信息按照需要添加到配置文件中，无需复制全部默认配置信息
  • publish 和 subscribe 配置会覆盖全局配置
yaml
llhls:
  http:
    listenaddr: :8080 # 网关地址，用于访问API
    listenaddrtls: :8443 # 用于HTTPS方式访问API的端口配置
    certfile: ""
    keyfile: ""
    cors: true # 是否自动添加cors头
    username: "" # 用户名和密码，用于API访问时的基本身份认证
    password: ""
    readtimeout: 0 # 读超时时间
    writetimeout: 0 # 写超时时间
    idletimeout: 0 # 空闲超时时间
hls:
  http:
    listenaddr: :8080 # 网关地址，用于访问API
    listenaddrtls: :8443 # 用于HTTPS方式访问API的端口配置
    certfile: ""
    keyfile: ""
    cors: true # 是否自动添加cors头
    username: "" # 用户名和密码，用于API访问时的基本身份认证
    password: ""
    readtimeout: 0 # 读超时时间
    writetimeout: 0 # 写超时时间
    idletimeout: 0 # 空闲超时时间
  publish:
    pubaudio: true # 是否发布音频流
    pubvideo: true # 是否发布视频流
    kickexist: false # 剔出已经存在的发布者，用于顶替原有发布者
    insertsei: false # 是否启用插入SEI功能
    publishtimeout: 10s # 发布流默认过期时间，超过该时间发布者没有恢复流将被删除
    idletimeout: 0 # 发布者空闲超时时间，超过该时间发布者没有任何操作将被删除，0为关闭该功能
    delayclosetimeout: 0 # 自动关闭触发后延迟的时间(期间内如果有新的订阅则取消触发关闭)，0为关闭该功能，保持连接。
    waitclosetimeout: 0 # 发布者断开后等待时间，超过该时间发布者没有恢复流将被删除，0为关闭该功能，由订阅者决定是否删除
    buffertime: 0 # 缓存时间，用于时光回溯，0为关闭缓存
    key: "" # 订阅者鉴权秘钥
    secretargname: secret # 订阅者鉴权参数名
    expireargname: expire # 订阅者鉴权过期时间参数名
    speedlimit: 500ms # 限速超时时间0为不限速，对于读取文件这类流需要限速，否则读取过快
  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 # 是否内部订阅，内部订阅不会触发发布者自动断开功能
  pull: # 格式 https://m7s.live/guide/config.html#%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE
  fragment: 10s # TS分片长度
  window: 2 # 实时流m3u8文件包含的TS文件数
  filter: "" # 正则表达式，用来过滤发布的流，只有匹配到的流才会写入
  path: "" # 远端拉流如果需要保存的话，存放的目录
  defaultts: "" # 默认切片用于无流时片头播放,如果留空则使用系统内置
  defaulttsduration: 3.88s # 默认切片的长度
  relaymode: 0 # 转发模式,0:转协议+不转发,1:不转协议+转发，2:转协议+转发
  preload: false # 是否预加载,预加载后会所有的 HLS 订阅都会共享一个内部订阅者，可以加快播放速度，但是无法使用按需关流

转发模式 ​

转发模式仅仅对从远端拉流的 hls 起作用。relaymode 可以配置不同的转发模式，其中，转协议意味着 hls 可以拉流可以转换成其他协议格式，即需要对 hls 的数据进行解析。

转发意味着 hls 中的 ts 文件缓存在服务器，可以在从服务器拉流时直接读取 ts 文件。

例如，如果希望只做 hls 的纯转发，减少 cpu 消耗，可以配置

yaml
hls:
  relaymode: 1

HLS.js 测试页面 ​

访问 http://localhost:8080/hls/index.html

域名和端口根据实际情况修改