混流录制

编辑文档更新于 2024-11-11 06:14:32

描述

在录制过程中，可以随时调用本接口更改混流布局的设置和录制的流

接口请求地址

请求方式：POST/JSON
传输协议：HTTPS
调用频次限制：50 次/秒
请求 URL：

https://brtc-api.baijiayun.com/vcs/recording/stream/mix/update

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId, 唯一标识一个应用
room_id	string	是	录制的房间 id
task_id	string	是	录制任务 id
input_params	json	是	录制任务输入参数

input_params 成员

参数	类型	是否必选	描述
main_user_id	string	否	主窗口用户 id, mix_mode 为 2、3、4 时生效
mix_config	json	否	混流参数

mix_config 成员

参数	类型	是否必选	描述
input_list	json	是	布局参数

input_list 成员

参数	类型	是否必选	描述
user_id	string	是	录制用户 id
stream_type	int	否	流类型 0: 大流 1: 小流 2: 辅流(屏幕分享) 若对方未开启大小流, 默认为大流
x	int	是	表示画面左上角在画布中的横坐标相对值
y	int	是	表示画面左上角在画布中的纵坐标相对值
width	int	是	是画面宽的相对值, 取值范围 2 到输出视频宽度最大值
height	int	是	是画面高的相对值, 取值范围 2 到输出视频高度最大值
z_order	int	是	图层堆叠顺序如果画面有重叠通过 z_order 可设置画面堆叠的顺序拥有更大堆叠顺序的画面会覆盖堆叠顺序较小的画面

请求示例

请求包体内容：

{
    "app_id": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "room_id": "33669",
    "task_id": "33669@BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "input_params":{
        "mix_config":{
            "input_list":[
                {
                    "user_id": "122333",
                    "stream_type": 2,
                    "x": 2,
                    "y": 4,
                    "width": 360,
                    "height": 240,
                    "z_order": 1
                },
                {
                    "user_id": "12333",
                    "stream_type": 1,
                    "x": 2,
                    "y": 2,
                    "width": 360,
                    "height": 240,
                    "z_order": 1
                }
            ],
            "audio_only":[
                "1111",
                "222",
                "555"
            ],
        }
    }
}

响应参数

参数	类型	描述
code	int	错误码
msg	string	描述

响应示例

响应包体内容：

{
    "code": 200,
    "data": {},
    "msg": "succeed"
}