lal地址: https://github.com/q191201771/lal
接口列表
接口分为两大类:
- 查询类型的,以
/api/stat
开头 - 控制类型的,以
/api/ctrl
开头
1 | 1.1. /api/stat/group // 查询特定group的信息 |
名词解释:
- group: lal中的group是群组的概念,lal作为流媒体服务器,通过流名称将每1路输入流转发给1~n路输出流,流名称相同的输入输出流被同1个group群组管理。
所有接口的返回结果中,必含的一级参数:
1 | { |
error_code
列表:
error_code | desp | 说明 |
---|---|---|
0 | succ | 调用成功 |
1001 | group not found | group不存在 |
1002 | param missing | 必填参数缺失 |
1003 | session not found | session不存在 |
接口详情
1.1. /api/stat/group
- 简要描述: 查询指定group的信息
- 请求URL:
http://127.0.0.1:8083/api/stat/group?stream_name=test110
- 请求方式:
HTTP GET
- 请求参数:
- stream_name | 必填项 | 指定group的流名称
- 返回值
error_code
可能取值:- 0 group存在,查询成功
- 1001 group不存在
- 1002 必填参数缺失
返回示例:
1 | { |
1.2. /api/stat/all_group
- 简要描述: 查询所有group的信息
- 请求URL示例:
http://127.0.0.1:8083/api/stat/all_group
- 请求方式:
HTTP GET
- 请求参数: 无
- 返回值
error_code
可能取值:- 0 查询成功
返回示例:
1 | { |
1.3. /api/stat/lal_info
- 简要描述: 查询服务器信息
- 请求URL示例:
http://127.0.0.1:8083/api/stat/lal_info
- 请求方式:
HTTP GET
- 请求参数: 无
- 返回值
error_code
可能取值:- 0 查询成功
返回示例:
1 | { |
2.1. /api/ctrl/start_pull
- 简要描述: 控制服务器主动从远端拉流至本地
- 请求方式:
HTTP POST
请求示例:
1 | $curl -H "Content-Type:application/json" -X POST -d '{"protocol": "rtmp", "addr":"127.0.0.1:19550", "app_name":"live", "stream_name":"test110", "url_param":"token=aaa&p2=bbb"}' http://127.0.0.1:8083/api/ctrl/start_pull |
请求参数说明:
1 | { |
返回值error_code
可能取值:
- 0 请求接口成功。注意,返回成功并不保证从远端拉流成功
- 1002 参数错误
2.2. /api/ctrl/kick_out_session
- 简要描述: 强行踢出关闭指定session,比如rtmp pub推流会话、http-flv sub拉流会话等
- 请求方式:
HTTP POST
请求示例:
1 | $curl -H "Content-Type:application/json" -X POST -d '{"stream_name": "test110", "session_id": "FLVSUB1"}' http://127.0.0.1:8083/api/ctrl/kick_out_session |
请求参数说明:
1 | { |
返回值error_code
可能取值:
- 0 请求接口成功。指定会话被关闭
- 1001 指定流名称对应的group不存在
- 1003 指定会话不存在
其他
HTTP API模块还提供一个API列表页面,地址为http://127.0.0.1:8083/api/list
1 | 本文档基于版本: |
本文完,作者yoko,尊重劳动人民成果,转载请注明原文出处: https://pengrl.com/p/20100/