API参考
优质
小牛编辑
132浏览
2023-12-01
媒体参数说明
视频参数:
| 参数 | 描述 | 类型 |
|---|---|---|
| videoAddress | 视频地址 | string |
| positions | 视频位置，层级，持续时间等参数 | 视频位置参数数组 |
视频位置参数:
| 参数 | 描述 | 类型 |
|---|---|---|
| x | x坐标 | int |
| y | y坐标 | int |
| w | 视频宽 | int |
| h | 视频高 | int |
| layerIndex | 在视频中的层级 | int |
| duration | 持续时间 | int |
图片参数:
| 参数 | 描述 | 类型 |
|---|---|---|
| imageAddress | string | |
| x | x坐标 | int |
| y | y坐标 | int |
| w | 图片宽 | int |
| h | 图片高 | int |
| layerIndex | 在视频中的层级 | int |
| startTime | 图片在视频中的出现时间 | int |
| duration | 持续时间 | int |
| stretchMode | 图片拉伸模式 0:铺满 1:按比例缩放 | int |
任务参数:
| 参数 | 描述 | 类型 |
|---|---|---|
| id | string | |
| progress | 范围0-1 | float |
| status | int | |
| videoInfo | 可选 视频参数 | map |
| imageInfos | 图片参数数组 | array |
| targetUrl | 输出的视频地址 仅当status为混流成功时才存在 | string |
创建混流任务
POST: /stream-mixer/api/create
接口参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| outputWidth | 输出视频宽度 | int | |
| outputHeight | 输出视频高度 | int | |
| bitrate | 码率 | int | 单位bps |
| format | 输出视频格式 | int | 0:m3u8 1:flv 2:mp4 |
| videoInfo | 视频信息 | map | 可选 格式为视频参数 |
| imageInfos | 图片信息数组 | array | 格式为图片参数 |
返回参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| id | 混流id | string | |
| errcode | 错误码 | int | 成功:1000 |
删除混流任务
POST: /stream-mixer/api/delete
接口参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| id | 混流id | string |
返回参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| errcode | 错误码 | int | 成功:1000 |
查询混流任务进度
GET: /stream-mixer/api/progress
接口参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| id | 混流id | string |
返回参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| errcode | 错误码 | int | 成功:1000 |
| progress | 混流进度 | float | 范围0-1 |
| id | 混流任务id | string | |
| status | 状态 | int | 0:等待混流 1:混流中 2:混流成功 3:混流失败 4:已删除 |
| videoInfo | 视频信息 | map | 可选 格式为视频参数 |
| imageInfos | 图片信息数组 | array | 格式为图片参数 |
| targetUrl | 输出的视频地址 | string | 仅当status为混流成功时才存在 |
查询混流任务列表 POST: /stream-mixer/api/list
接口参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| page | 页码 | int | 默认:1 |
| limit | 个数 | int | 默认:15 |
| type | 任务类型 | int | 0:等待混流 1:混流中 2:混流成功 3:混流失败 4:已删除 |
返回参数:
| 参数 | 描述 | 类型 | 特别说明 |
|---|---|---|---|
| errcode | 错误码 | int | 成功:1000 |
| count | 结果个数 | int | |
| tasks | 任务列表 | array | 结构为任务参数 |
| 错误码 | 含义 |
|---|---|
| 1000 | 成功 |
| 2000 | 参数错误 |
| 2001 | 用户未授权 |
| 2002 | 没有可用节点 |
| 2003 | 停止流媒体任务失败 |
| 2004 | 转存失败 |
| 2005 | 数据库添加任务失败 |
| 2006 | 数据库获取任务失败 |
| 2007 | 数据库删除任务失败 |
| 2008 | 数据库设置进度失败 |
| 2009 | 数据库获取任务列表失败 |
| 2010 | 数据库获取转存任务失败 |
| 2011 | 数据库设置任务失败错误 |
| 2012 | 数据库设置转存任务id失败 |
| 2013 | 数据库不存在该任务 |