# plugin-hls

**Repository Path**: m7s/plugin-hls

## Basic Information

- **Project Name**: plugin-hls
- **Description**: No description available
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: v4
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-17
- **Last Updated**: 2022-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HLS插件

1. 该插件可用来拉取网络上的m3u8文件并解析后转换成其他协议
2. 该插件可以在服务器写HLS文件，并且可以播放
3. 可以直接访问`http://localhost:8080/hls/live/user1.m3u8` 进行播放，其中8080端口是全局HTTP配置，live/user1是streamPath，需要根据实际情况修改
4. 支持回放功能，即每次发布流后均会产生一个m3u8文件，可以通过该文件进行回放 `http://localhost:8080/hls/live/user1/xxxxxxxxxx.m3u8` 其中xxxxxxxx代表发布的时间戳（Unix时间戳）

## 插件地址

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

## 插件引入
```go
import (
    _ "m7s.live/plugin/hls/v4"
)
```

## API
> 参数是可变的，下面的参数live/hls是作为例子，不是固定的
- `/hls/api/list`
列出所有HLS流，是一个SSE，可以持续接受到列表数据
- `/hls/api/save?streamPath=live/hls`
保存指定的流（例如live/hls）为HLS文件（m3u8和ts）当这个请求关闭时就结束保存（该API仅作用于远程拉流）
- `/hls/api/pull?streamPath=live/hls&target=http://localhost/abc.m3u8`
将目标HLS流拉过来作为媒体源在monibuca内以`live/hls`流的形式存在
## 配置

```yaml
hls:
    publish:
        pubaudio: true
        pubvideo: true
        kickexist: false
        publishtimeout: 10
        waitclosetimeout: 0
    pull:
        repull: 0
        pullonstart: false
        pullonsubscribe: false
        pulllist: {}
    subscribe:
        subaudio: true
        subvideo: true
        iframeonly: false
        waittimeout: 10
    fragment: 10 # TS分片长度，单位秒
    window: 2 # 实时流m3u8文件包含的TS文件数
    enablewrite: false # 用来控制是否启用HLS文件写入功能
    enablememory: false # 用来启用内存播放模式，开启后ts数据会保存在内存中
    filter: "" # 正则表达式，用来过滤发布的流，只有匹配到的流才会写入
    path: hls
```