Monibuca

Appearance

RTSP 插件 ​

rtsp 插件提供 rtsp 协议的推拉流能力，以及向远程服务器推拉 rtsp 协议的能力。

插件地址 ​

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

插件引入 ​

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

推拉地址形式 ​

sh
rtsp://localhost/live/test
  • localhost是 m7s 的服务器域名或者 IP 地址，默认端口554可以不写，否则需要写
  • live代表appName
  • test代表streamName
  • m7s 中live/test将作为streamPath为流的唯一标识

例如通过 ffmpeg 向 m7s 进行推流

bash
ffmpeg -i [视频源] -c:v h264 -c:a aac -f rtsp rtsp://localhost/live/test

会在 m7s 内部形成一个名为 live/test 的流

如果 m7s 中已经存在 live/test 流的话就可以用 rtsp 协议进行播放

bash
ffplay rtsp://localhost/live/test

配置 ​

yaml
rtsp:
  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
  push: # 格式参考文档 https://m7s.live/guide/config.html#%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE
  listenaddr: :554
  udpaddr: :8000
  rtcpaddr: :8001
  readbuffercount: 2048 # 读取缓存队列大小
  writebuffercount: 2048 # 写出缓存队列大小
  pullprotocol: tcp # auto, tcp, udp

配置覆盖

publish subscribe 两项中未配置部分将使用全局配置

接口 API ​

获取所有 RTSP 流 ​

  • URL: /rtsp/api/list
  • 请求方式: GET
  • 描述: 获取所有 RTSP 流的列表
  • 返回: 所有 RTSP 流的列表

从远程拉取 RTSP 流到 m7s 中 ​

  • URL: rtsp/api/pull
  • 请求方式: GET
  • 参数:
参数名必填类型描述
target是string远程 RTSP 地址，需要进行 urlencode 以防止特殊字符影响解析
streamPath是string流标识，用于标识特定的流
save是int保存选项：0、不保存；1、保存到 pullonstart；2、保存到 pullonsub
  • 示例:
    • rtsp/api/pull?target=[RTSP地址]&streamPath=[流标识]&save=[0|1|2]]

将本地的流推送到远端 ​

  • URL: rtsp/api/push
  • 请求方式: GET
  • 参数:
参数名必填类型描述
target是string远端 RTSP 地址，需要进行 urlencode 以防止特殊字符影响解析。
streamPath是string流标识，用于标识特定的流。
  • 示例:
    • rtsp/api/push?target=[RTSP地址]&streamPath=[流标识]