Skip to content

English | 简体中文

PS 插件

支持接收 MpegPS 流

插件地址

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

插件引入

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

默认配置

yaml
ps:
  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 # 是否内部订阅,内部订阅不会触发发布者自动断开功能
  relaymode: 1 # 0:纯转发 1:转协议,不转发 2:转发并且转协议

接口 API

接收 PS 流

  • URL: /ps/api/receive
  • 请求方式: GET
  • 参数:
参数名必填类型描述
streamPathstring流标识,用于标识特定的流
ssrcstring设备发送的 ssrc
portstring端口号
reuseint是否端口复用,1 表示复用,0 表示不复用。如果使用端口复用,请务必确定设备发送的 ssrc 和 ssrc 参数一致,否则会出现混流的情况
dumpstring是否 dump 到文件,如果 dump 到文件,会在当前目录下生成一个以 dump 为名的文件夹,文件夹下面是以 streamPath 参数值为名的文件,文件内容从端口收到的数据[4byte 内容长度][2byte 相对时间][内容]
  • 示例:
    • /ps/api/receive?streamPath=xxx&ssrc=xxx&port=xxx&reuse=1&dump=xxx

回放 PS 的 dump 文件

  • URL: /ps/api/replay
  • 请求方式: GET
  • 参数:
参数名必填类型描述
streamPathstring代表回放时生成的视频流的 streamPath, 默认是 replay/dump/ps (如果 dump 传了 abc, 那么 streamPath 默认是 replay/abc)
dumpstringdump 代表需要回放的文件,默认是 dump/ps
  • 示例:
    • /ps/api/replay?streamPath=xxx&dump=xxx

以 ws 协议读取 PS 流

  • URL: ws://[host]/ps/[streamPath]
  • 描述: 数据包含的是裸的 PS 数据,不包含 rtp 头
  • 示例:
    • ws://localhost:8080/ps/live/test