混流录制

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

描述

在开始录制前, 必须调用 mix 方法请求一个用于云端录制的 taskId

接口请求地址

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

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

API鉴权

参见 Restful API 基本认证

请求参数

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

input_params 成员

参数	类型	是否必选	描述
main_user_id	string	否	主窗口用户 id, 切换主窗口, 主窗口都是高清流, mix_mode 为 2、3、4 时生效
stream_type	int	否	流类型： 0、仅录制音频 1、仅录制视频 2、同时录制音视频
fill_frame	json	否	混流时, 混流视频参数
watermarks	json	否	混流输出视频的水印参数
mix_config	json	是	混流参数

fill_frame 成员

参数	类型	是否必选	描述
fill_mode	int	否	视频填充模式 0: 补黑边(默认) 1: 裁剪 2: 拉伸填充

watermarks 成员

参数	类型	是否必选	描述
type	string	否	水印类型 time: 时间水印(默认) text: 文字水印 image:图片水印
offset_x	int	否	水印水平位置, 默认为 0
offset_y	int	否	水印垂直位置, 默认为 0
text	string	否	文字水印文字, 仅支持 UTF-8 编码
font_size	int	否	时间、文字水印文字大小, 默认为 12px
font_color	string	否	时间、文字水印文字颜色，支持 RGB 十六进制格式的颜色, 默认为 #0000FF
url	string	否	图片水印, 图片地址

一个视频输出文件最多可以添加 25 个文字、25 个时间水印和 25 个图片水印
水印框完全透明, 无颜色
如果水印超出画布范围, 则水印框与画布的交集区域会作为显示区域
图片水印, 图片宽高为图片的实际宽高

mix_config 成员

参数	类型	是否必选	描述
mix_mode	int	是	布局方式(暂时只支持 1) 1: 自定义布局 2: 画廊布局(默认) 3:演讲布局 4:悬浮布局
input_list	json	是	布局参数
audio_only	json	否	纯音频用户user_id
video	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 可设置画面堆叠的顺序拥有更大堆叠顺序的画面会覆盖堆叠顺序较小的画面

video 成员

参数	类型	是否必选	描述
size	string	是	输出视频的分辨率
fps	int	是	输出视频的帧率, 默认 15, 有效范围 [5,30]
bit_rate	int	是	输出视频的码率, 单位: kbps, 有效范围 [5,4096]
background_color	string	是	输出视频背景颜色, 支持 RGB 十六进制格式的颜色

输出视频的分辨率size可选值

size 类型
120x120
160x90
160x120
160x160
256x144
240x180
320x180
280x210
270x270
320x240
400x300
480x270
480x360
480x480
640x360
640x480
960x540
960x720
1280x720
1920x1080

请求示例

请求包体内容：

{
    "app_id": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "room_id": "33669",
    "input_params": {
        "main_user_id": "20",
        "fill_frame": {
            "fill_mode": 1
        },
        "watermarks": [{
                "type": "text",
                "text": "abc123",
                "offset_x": 100,
                "offset_y": 100,
                "font_size": 70,
                "font_color": "#FFFFFF"
            },
            {
                "type": "text",
                "text": "this is name",
                "offset_x": 100,
                "offset_y": 100,
                "font_size": 70,
                "font_color": "#FFFFFF"
            },
            {
                "type": "time",
                "offset_x": 100,
                "offset_y": 100,
                "font_size": 70,
                "font_color": "#FFFFFF"
            },
            {
                "type": "image",
                "offset_x": 100,
                "offset_y": 100,
                "url": "https://xxx.png"
            }
        ],
        "mix_config": {
            "mix_mode": 1,
            "input_list": [{
                    "user_id": "122333",
                    "stream_type": 1,
                    "x": 2,
                    "y": 2,
                    "width": 360,
                    "height": 240,
                    "z_order": 1
                },
                {
                    "user_id": "12333",
                    "stream_type": 1,
                    "x": 200,
                    "y": 40,
                    "width": 360,
                    "height": 240,
                    "z_order": 1
                }
            ],
            "audio_only": [
                "1111",
                "222",
                "555"
            ],
            "video": {
                "size": "1280x720",
                "bit_rate": 1024,
                "background_color": "#ffffff",
                "fps": 15
            }
    }
  }
}

响应参数

参数	类型	描述
code	int	错误码
msg	string	错误描述
task_id	string	云录制服务分配的任务 id。任务 id 是对一次录制生命周期过程的唯一标识, 结束录制时会失去意义。未开始录制时 task_id 的有效期为 5 分钟

响应示例

响应包体内容：

{
    "code": 200,
    "data": {
        "task_id": "33669@BZ2no1v919Die6mLc2nNOGvfqcQNSfKO"
    },
    "msg": "succeed"
}