tencent cloud

直播 SDK

动态与公告
TUILiveKit 产品动态
云直播推拉流 SDK 产品动态
新手指引
产品简介
产品概述
产品优势
性能数据
基本概念
购买指南
TRTC Live 价格总览
Live 视频直播计费说明
开通服务（TUILiveKit）
Demo 体验
Demo 体验指引
跑通 Demo（TUILiveKit）
接入指南
视频直播
准备工作
主播开播
观众观看
直播列表
语聊房
准备工作
主播开播
观众观看
直播列表
推流助手
推流助手（Electron 桌面应用）
推流助手（Web 桌面浏览器）
直播监播
监播页面（Web 桌面浏览器 React 版）
监播页面（Web 桌面浏览器 Vue 版）
UI 自定义
直播视频组件
视频源编辑组件
观众列表组件
聊天弹幕组件
媒体源配置面板
连麦管理面板
直播送礼组件
无 UI 集成
搭建视频直播
搭建语聊房
功能指南
关注主播（TUILiveKit）
至臻画质（TUILiveKit）
输入媒体流进房（TUILiveKit）
礼物系统（TUILiveKit）
客户端 API
Android
iOS
Web
服务端 API（TUILiveKit）
账号系统
REST API
第三方回调
错误码（TUILiveKit）
常见问题
平台编译
用户鉴权
云直播推拉流 SDK
产品简介
购买指南
Demo 体验
免费测试
SDK 下载
License 管理
高级功能
客户端 API
常见问题
无 UI 集成方案
API 文档
OSS information
OSS Attribution Notice
文档直播 SDK服务端 API（TUILiveKit）REST API房间相关设置房间混流布局

设置房间混流布局

PDF
聚焦模式
字号
最后更新时间： 2026-03-11 10:14:28

功能说明

App 管理员可以通过该接口设置指定房间的混流布局画面。
注意：
要使用该能力前提是: 需要创建房间的时候打开房间的混流能力，即 IsUnlimitedRoomEnabled 设置为 true, 对应SDK侧 TUILiveKit 视频房 组件创建的房间。
混流涉及的主播必须都在麦上。

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/set_mix_stream?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
美国：adminapiusa.im.qcloud.com
v4/live_engine_http_srv/set_mix_stream
请求接口
sdkappid
创建 Live 应用分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

20次/秒。

请求包示例

九宫格模式
{
	"RoomId":"mix1",
	"LayoutMode":0, //九宫格模式
	"VideoEncode":{
		"Width":720,
		"Height":1280
	}
 }
自定义模式
{
	"RoomId":"mix1",
	"LayoutMode":1000,
	"VideoEncode":{
		"Width":720,
		"Height":1280
	},
	"LayoutInfo":{
		"LayoutList":[
			{
				"LocationX":0,
				"LocationY":0,
				"ImageWidth":360,
				"ImageHeight":1280,
				"RoomId":"mix1",
				"Member_Account":"brennanli",
				"StreamType":0,
				"ZOrder":1
			},
            {
				"LocationX":360,
				"LocationY":0,
				"ImageWidth":360,
				"ImageHeight":1280,
				"RoomId":"mix1",
				"Member_Account":"tandy",
				"StreamType":0,
				"ZOrder":1
			},
             {  //表示只需要展示音频, 不需要画面
				"LocationX":0,
				"LocationY":0,
				"ImageWidth":0,
				"ImageHeight":0,
				"RoomId":"mix1",
				"Member_Account":"faker",
				"StreamType":0,
				"ZOrder":1
			},
   		]
	}
}
悬浮画面
{
	"RoomId":"mix1",
	"LayoutMode":1000,
	"VideoEncode":{
		"Width":720,
		"Height":1280
	},
	"LayoutInfo":{
		"LayoutList":[
			{
				"LocationX":540,
				"LocationY":960,
				"ImageWidth":180,
				"ImageHeight":320,
				"RoomId":"mix1",
				"Member_Account":"brennanli",
				"StreamType":0,
				"ZOrder":1
			}
		],
        "MaxUserLayout":{
				"RoomId":"mix1",
				"Member_Account":"tandy",
				"StreamType":0,
				"ZOrder":0
		}
	}
}
屏幕共享画面
{
	"RoomId":"mix1",
	"LayoutMode":1000,
	"VideoEncode":{
		"Width":720,
		"Height":1280
	},
	"LayoutInfo":{
		"LayoutList":[
			{
				"LocationX":630,
				"LocationY":0,
				"ImageWidth":90,
				"ImageHeight":160,
				"RoomId":"mix1",
				"Member_Account":"brennanli",
				"StreamType":0,
				"ZOrder":1

			}
		],
        "MaxUserLayout":{
				"RoomId":"mix1",
				"Member_Account":"brennanli",
				"StreamType":1,
				"ZOrder":0
		}
	}
}

请求包字段说明

字段
类型
属性
说明
RoomId
String
必填
房间 ID，最长48个字节
LayoutMode
Integer
必填
布局模式，默认为0
0表示默认的九宫格模式，单路流走旁路转推，多路流会转码混流下推
1000表示自定义模式，自定义模式下需要设置 VideoEncode, LayoutInfo 等字段，自定义模式下都会混流转码下推
VideoEncode
Object
选填
分辨率信息，默认为720P：
自定义模式下有效
九宫格模式下如果房间只有一个主播，会进行旁路转推，填写该参数无效
Width
Integer
选填
画面分辨率宽
Height
Integer
选填
画面分辨率高
LayoutInfo
Object
选填
混流画面布局信息，只有自定义模式下该字段有效
LayoutList
Array
选填
混流主播布局信息，只有自定义模式下该字段有效
MaxUserLayout
Object
选填
屏幕共享，悬浮窗时候的大画面，只有自定义模式下该字段有效
LayoutList 里的元素字段说明
字段
类型
属性
说明
LocationX
Integer
必填
该主播在画面的 x 位置
LocationY
Integer
必填
该主播在画面的 y 位置
ImageWidth
Integer
必填
该主播在画面的宽度
ImageHeight
Integer
必填
该主播在画面的高度
Member_Account
String
必填
主播账号 Id
StreamType
Integer
必填
流类型：
0表示摄像头流
1表示屏幕分享流
ZOrder
Integer
必填
主播画面层级：0表示最底层
RoomId
String
必填
该主播对应的房间 Id
MaxUserLayout 字段说明
字段
类型
属性
说明
Member_Account
String
必填
主播账号 Id
StreamType
Integer
必填
流类型：
0表示摄像头流
1表示屏幕分享流
ZOrder
Integer
必填
主播画面层级：0表示最底层
RoomId
String
必填
该主播对应的房间 Id

应答包体示例

基础形式
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
服务器内部错误，请重试
100002
请参数非法，请根据错误描述检查请求是否正确
100006
该房间类型需要时 Live 房间类型
100004
房间不存在或者已解散
100007
付费套餐不满足
100422
请求短时间过多，被频控，单个sdkappid所有混流操作叠加起来20/s
100424
混流任务不存在，请重试
100427
该房间混流操作过快，请稍后重试
上一篇: 删除房间自定义信息下一篇: 恢复房间混流任务

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈