API参考
优质
小牛编辑
134浏览
2023-12-01
接口目录
创建并开始推拉流任务
POST /switch/api/create
JSON 参数
参数 | 描述 | 取值 |
---|---|---|
src_urls | 源视频列表 | string array |
dst_url | 推流地址,必须以 rtmp:// 开头 | string |
loop | 是否循环,默认 false | bool |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
id | 推拉流任务 ID | string |
返回示例:
{
"errcode": 1000,
"id": "17lok52y",
"msg": "OK"
}
获取推拉流任务列表
GET /switch/api/list
URL 参数
参数 | 描述 | 取值 |
---|---|---|
page | 页数,默认 1 | int |
page_size | 每页个数,默认 15 | int |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
tasks | 推拉流任务列表 | object array |
tasks.id | 推拉流任务 ID | string |
tasks.created_at | 创建时间 | string |
tasks.updated_at | 更新时间 | string |
tasks.src_urls | 源视频列表 | string array |
tasks.dst_url | 推流地址 | string |
tasks.loop | 是否循环 | bool |
tasks.pause | 是否暂停状态 | bool |
tasks.running | 是否正在推流(任务成功开始后为 true,任务结束后为 false) | bool |
tasks.current_index | 当前播第几个视频(从 0 开始) | int |
tasks.current_bit_rate | 当前视频帧率 | int |
tasks.current_fps | 当前视频码率 | int |
count | 推拉流任务总个数 | int |
返回示例:
{
"count": 33,
"errcode": 1000,
"msg": "OK",
"tasks": [
{
"id": "17lok52y",
"created_at": "2010-11-22T15:16:17+08:00",
"updated_at": "2010-11-22T15:16:17+08:00",
"src_urls": [
"http://cdn12.mudu.tv/uploads/9/1280_720/ca2965c27bf931a18795ebd17d037ccd.m3u8",
"http://cdn12.mudu.tv/uploads/9/640_480/53515dc0fccf78fcabcccf4f108683ce.m3u8"
],
"dst_url": "rtmp://pub.mudu.tv/watch/7ffz1c",
"loop": false,
"pause": false,
"running": true,
"current_index": 1,
"current_bit_rate": 862,
"current_fps": 25
}
]
}
获取推拉流任务
GET /switch/api/get
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
task | 推拉流任务 | object |
task.id | 推拉流任务 ID | string |
task.created_at | 创建时间 | string |
task.updated_at | 更新时间 | string |
task.src_urls | 源视频列表 | string |
task.dst_url | 推流地址 | string |
task.loop | 是否循环 | bool |
task.pause | 是否暂停状态 | bool |
task.running | 是否正在推流(任务成功开始后为 true,任务结束后为 false) | bool |
task.current_index | 当前播第几个视频(从 0 开始) | int |
task.current_bit_rate | 当前视频帧率 | int |
task.current_fps | 当前视频码率 | int |
返回示例:
{
"errcode": 1000,
"msg": "OK",
"task": {
"id": "17lok52y",
"created_at": "2010-11-22T15:16:17+08:00",
"updated_at": "2010-11-22T15:16:17+08:00",
"src_urls": [
"http://cdn12.mudu.tv/uploads/9/1280_720/ca2965c27bf931a18795ebd17d037ccd.m3u8",
"http://cdn12.mudu.tv/uploads/9/640_480/53515dc0fccf78fcabcccf4f108683ce.m3u8"
],
"dst_url": "rtmp://pub.mudu.tv/watch/7ffz1c",
"loop": false,
"pause": false,
"running": true,
"current_index": 1,
"current_bit_rate": 862,
"current_fps": 25
}
}
删除推拉流任务
POST /switch/api/delete
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
返回示例:
{
"errcode": 1000,
"msg": "OK"
}
批量删除推拉流任务
POST /switch/api/delete_switch_tasks
URL 参数
参数 | 描述 | 取值 |
---|---|---|
ids | 推拉流任务 ID(用 , 隔开) | string |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
返回示例:
{
"errcode": 1000,
"msg": "OK"
}
设置是否循环播放
POST /switch/api/set_loop
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
JSON 参数
参数 | 描述 | 取值 |
---|---|---|
loop | 是否循环 | bool |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
status | 该返回值已废弃,可忽略 | bool |
返回示例:
{
"errcode": 1000,
"msg": "OK",
"status": true
}
设置暂停恢复
POST /switch/api/set_pause
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
JSON 参数
参数 | 描述 | 取值 |
---|---|---|
pause | 是否暂停 | bool |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
status | 该返回值已废弃,可忽略 | bool |
返回示例:
{
"errcode": 1000,
"msg": "OK",
"status": true
}
切换播放的视频
POST /switch/api/set_index
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
JSON 参数
参数 | 描述 | 取值 |
---|---|---|
media_index | 播放的视频序号(从 0 开始) | int |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
status | 该返回值已废弃,可忽略 | bool |
返回示例:
{
"errcode": 1000,
"msg": "OK",
"status": true
}
切换进度
POST /switch/api/set_position
注意:切换进度后,推拉流会变成播放状态
URL 参数
参数 | 描述 | 取值 |
---|---|---|
id | 推拉流任务 ID | string |
JSON 参数
参数 | 描述 | 取值 |
---|---|---|
media_index | 播放的视频序号(从 0 开始) | int |
position | 进度(微秒) | int |
返回字段
参数 | 描述 | 取值 |
---|---|---|
errcode | 错误码,1000 为正常 | int |
msg | "OK" 或错误信息 | string |
status | 该返回值已废弃,可忽略 | bool |
返回示例:
{
"errcode": 1000,
"msg": "OK",
"status": true
}
错误码
错误码 | 错误描述 |
---|---|
2101 | 参数不合法 |
2102 | 服务资源不足 |
2111 | gRPC 开始任务失败 |
2112 | gRPC 停止任务失败 |
2113 | gRPC 设置任务循环状态失败 |
2114 | gRPC 设置任务暂停状态失败 |
2115 | gRPC 设置任务当前播放视频失败 |
2116 | gRPC 设置播放时间节点失败 |
2121 | 插入任务失败 |
2122 | 修改任务失败 |
2123 | 删除任务失败 |
2124 | 查询单个任务失败 |
2125 | 查询任务列表失败 |