API参考

优质
小牛编辑
134浏览
2023-12-01

接口目录

创建并开始推拉流任务

POST /switch/api/create

JSON 参数

参数描述取值
src_urls源视频列表string array
dst_url推流地址,必须以 rtmp:// 开头string
loop是否循环,默认 falsebool

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
id推拉流任务 IDstring

返回示例:

{
    "errcode": 1000,
    "id": "17lok52y",
    "msg": "OK"
}

获取推拉流任务列表

GET /switch/api/list

URL 参数

参数描述取值
page页数,默认 1int
page_size每页个数,默认 15int

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
tasks推拉流任务列表object array
tasks.id推拉流任务 IDstring
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推拉流任务 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
task推拉流任务object
task.id推拉流任务 IDstring
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推拉流任务 IDstring

返回字段

参数描述取值
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推拉流任务 IDstring

JSON 参数

参数描述取值
loop是否循环bool

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
status该返回值已废弃,可忽略bool

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "status": true
}

设置暂停恢复

POST /switch/api/set_pause

URL 参数

参数描述取值
id推拉流任务 IDstring

JSON 参数

参数描述取值
pause是否暂停bool

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
status该返回值已废弃,可忽略bool

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "status": true
}

切换播放的视频

POST /switch/api/set_index

URL 参数

参数描述取值
id推拉流任务 IDstring

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推拉流任务 IDstring

JSON 参数

参数描述取值
media_index播放的视频序号(从 0 开始)int
position进度(微秒)int

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
status该返回值已废弃,可忽略bool

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "status": true
}

错误码

错误码错误描述
2101参数不合法
2102服务资源不足
2111gRPC 开始任务失败
2112gRPC 停止任务失败
2113gRPC 设置任务循环状态失败
2114gRPC 设置任务暂停状态失败
2115gRPC 设置任务当前播放视频失败
2116gRPC 设置播放时间节点失败
2121插入任务失败
2122修改任务失败
2123删除任务失败
2124查询单个任务失败
2125查询任务列表失败