CloudHub 文档中心
下载中心 文档中心

RTS 实时流直播


API

API调用遵循HTTP协议。服务域名为 bayer-rts-console-api.cloudhub.vip。 数据交换格式为JSON,所有request/response body内容均采用UTF-8编码。

stream 相关

disable

禁播

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/disable

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填
start_time禁播起始时间Int13非必填13 位时间戳
例 : 1634196966
注意 : 不填写默认为当前时间
duration禁播时长Int非必填注意 :
1. 默认禁播1天(86400), 最小时间不能小于一天, 最长时间不限。
2. 禁播时长单位(m)

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

enabled

恢复禁播

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/enabled

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

status

获取流状态

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/status

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "data": {
        "id": "< stream_id > ",
        "stream_url": "< stream_url >",
        "status": "< ACTIVE/INACTIVE/FORBID >"
    }
}

录制相关

start

开始录制

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/start

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

pause

暂定录制

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/pause

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

resume

恢复录制

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/resume

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

stop

结束录制

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/stop

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

get_record_list

获取录制件列表

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/get_record_list

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填
record_id录制件idString非必填传值 : 可获取指定录制件数据
status录制件状态String非必填传值参数 : ONGOING , COMPLETE
page页码Int非必填默认 : 0, 传值例: 1,2,3…
page_size每页显示数据Int非必填默认值 : 15

返回值

正确返回

{
    "data": [
        {
            "record_id": "录制件id",
            "record_url": "录制件地址",
            "start_at": "录制开始时间",
            "end_at": "录制结束时间",
            "pause_total_duration": "录制件暂停时长",
            "duration": "录制件时长",
            "status": "录制件状态 : ONGOING/COMPLETE"
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

delete_record

删除录制件

接口地址

https://bayer-rts-console-api.cloudhub.vip/record/delete_record

参数

参数说明类型长度可选默认值备注
rts_app_id应用 AppIDString必填管理后台应用管理查看 AppID
stream_url流地址String必填
record_id录制件 idString非必填传值 : 删除指定已录制完成的录制件, 否则删除 stream_url 下所有已录制完成的录制件

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

混流相关

start_mixing

开始混流

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/start_mixing

参数

参数说明类型长度可选默认值备注
rts_app_id企业 AppIDstring32必填管理后台 应用管理查看 AppID
stream_url流地址string必填

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

set_mixing

设置混流

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/set_mixing

参数

参数说明类型长度可选默认值备注
rts_app_id企业 AppIDstring32必填管理后台 应用管理查看 AppID
stream_url流地址string必填流地址
mixing_config_str混流设置项json/string必填设置格式如下

mixing_config_str 格式示例

{
    "videoWidth": "输出视频的总宽度,单位为像素, * 如果混合流是音视频流,videoWidth >= 64, * 如果混合流是纯音频流,请将 videoWidth 和 videoHeight 设为 0(格式为整形)",
    "videoHeight": "输出视频的总高度,单位为像素, * 如果混合流是音视频流,videoHeight >= 64, * 如果混合流是纯音频流,请将 videoWidth 和 videoHeight 设为 0(格式为整形)",
    "videoFrameRate": "输出视频的帧率 (格式为整形)",
    "videoBandWidth": "输出视频的带宽,单位为 kbps,最大带宽 8M (格式为整形)",
    "backgroundColor": "背景色  默认: 0x000000 ,必须是 16 进制格式。 取值范围为 [0x000000, 0xffffff] (格式为字符串)",
    "audioBandWidth": "输出音频的码率,单位为 kbps,最大带宽 128 kbps (格式为整形)",
    "audioChannels": "输出音频的声道数,取值范围为 [1,2] 中的整型* 1: 单声道 * 2: 双声道 (格式为整形)",
    "mixingSources": [{
        "streamUrl": "参与合图的流地址(格式为字符串类型)",
        "x": "视频左上角的横轴位置 (格式为整形)",
        "y": "视频帧左上角的纵轴位置 (格式为整形)",
        "width": "视频宽度 (格式为整形)",
        "height": "视频高度 (格式为整形)",
        "zOrder": "视频的图层编号,取值范围为 [0,100], 最小值为 0,表示该区域图像位于最下层, 最大值为 100,表示该区域图像位于最上层 (格式为整形)",
        "fit": "视频是否完全显示 true: 视频完全显示(即:不裁剪),可能会出现黑边 false: 视频裁剪,不会出现黑边 (格式为整形)"
    }] // 备注: "参与合图的源,类型为 Array,数组项为 mixingSources, 最多支持 24 个源同时参与合图"
}

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

stop_mixing

停止混流

接口地址

https://bayer-rts-console-api.cloudhub.vip/stream/stop_mixing

参数

参数说明类型长度可选默认值备注
rts_app_id企业 AppIDstring32必填管理后台 应用管理查看 AppID
stream_url流地址string必填流地址

返回值

正确返回

{
    "code": "200",
    "message": "success"
}

状态码

http 状态码说明

状态码说明
200服务器成功
401未授权
404请求地址不存在
422请求参数或者格式错误
500服务器内部错误

状态内容参考

http 返回 200 状态码,获取 json 内容结构如下:

{
    "code": "200",
    "message": "success"
}

http 返回 401 状态码,获取 json 内容结构如下:

{
    "message": "unauthorized",
    "status_code": 401,
}

http 返回 404 状态码,获取 json 内容结构如下:

{
    "message": "404 Not Found",
    "status_code": 404,
}

http 返回 422 状态码,获取 json 内容结构如下:

{
    "errors":{

    }
    "message": "The given data was invalid.",
    "status_code": 422,
}

http 返回 500 状态码后,获取 json 内容结构如下:

{
    "code":"500"
    "message": "internal error",
    "status_code": 500,
}