tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

TUILiveLayoutManager

PDF
聚焦模式
字号
最后更新时间: 2025-09-18 16:06:00
Function: 直播自定义布局相关接口,此页面中的函数仅支持直播房间类型(LIVE)。

TUILiveLayoutManager

函数接口
说明
设置自定义布局信息
on
off
取消 TUILiveLayoutManagerEvents 事件监听

TUILiveLayoutManagerEvents

事件接口
说明
直播画面布局发生改变事件
麦位排版信息发生变化事件

类型定义

类型
说明
直播间麦位排版
麦位排版信息
麦上用户的媒体状态信息

函数接口详情

setLiveStreamLayoutInfo

设置自定义布局信息。
const roomEngine = new TUIRoomEngine();
const liveLayoutManager = roomEngine.getLiveLayoutManager();
const layoutData = {
// 设置画布大小
VideoEncode: {
Width: 1920,
Height: 1080,
},
LayoutMode: 1000, // 0~9 内置布局模板, 1000 为自定义布局, 只有为1000 时才能 LayoutInfo 属性才有效
// 设置画面布局
LayoutInfo: {
LayoutList: [
{
LocationX: 0, // 以画面左上角为原点的 x 坐标
LocationY: 0, // 以画面左上角为原点的 y 坐标
ImageWidth: 1080, // 调整后的画面宽度
ImageHeight: 960, // 调整后的画面高度
ZOrder: 0, // 画面层级,取值范围: 0 ~ +∞
StreamType: 0, // 0 摄像头, 1 屏幕共享, 2 白板, 3 自定义
Member_Account: 'admin001', // 该路流的用户ID
BackgroundImageUrl: 'ImageUrl', // 可为空
RoomId: 'roomId',
BackgroundColor: '0x1F212C', // 可为空
},
],
},
// 设置最大画面布局信息
MaxUserLayout: {
LocationX: 0, // 以画面左上角为原点的 x 坐标
LocationY: 0, // 以画面左上角为原点的 y 坐标
ImageWidth: 1920, // 调整后的画面宽度
ImageHeight: 1080, // 调整后的画面高度
ZOrder: 0, // 画面层级,最大画面层级推荐为 0
StreamType: 0, // 0为摄像头, 1为屏幕共享
Member_Account: 'admin001', // 该路流的用户ID
BackgroundImageUrl: 'ImageUrl', // 可以设置看看,可能在最大画面时候没作用
RoomId: 'roomId',
BackgroundColor: '0x1F212C'
},
};

const roomId = 'roomId';
const layoutInfo = JSON.stringify(layoutData);
await liveLayoutManager.setLiveStreamLayoutInfo(roomId, layoutInfo);

注意:
layoutData 对象内的所有 Key 值均是大驼峰。
目前 LayoutMode 属性值只支持 0 和 1000。
只有 LayoutMode 为 1000 时设置 LayoutInfo 属性才有效,当 LayoutMode 为 0~9 时可以不用传 LayoutInfo、VideoEncode 属性。
LayoutInfo.LayoutList 是一个数组,可以设置多路画面的布局信息。
参数
类型
是否必填
默认值
说明
roomId
String
-
直播房间 ID。
layoutInfo
String
-
自定义布局信息,格式为 JSON 字符串。
返回值:Promise<void>

on

const roomEngine = new TUIRoomEngine();
const liveLayoutManager = roomEngine.getLiveLayoutManager();
const callback = (roomId, layoutInfo) => {
console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
};
liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);

参数
类型
是否必填
默认值
说明
eventName
-
事件名。
func
(...args: any[]) => void
-
事件处理函数。
返回值:void

off

取消 TUILiveLayoutManagerEvents 事件监听。
const roomEngine = new TUIRoomEngine();
const liveLayoutManager = roomEngine.getLiveLayoutManager();
const callback = (roomId, layoutInfo) => {
console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
};
liveLayoutManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);

参数
类型
是否必填
默认值
说明
eventName
-
事件名。
func
(...args: any[]) => void
-
事件处理函数。
返回值:void

事件接口详情

onLiveVideoLayoutChanged

直播画面布局发生改变事件。
const roomEngine = new TUIRoomEngine();
const liveLayoutManager = roomEngine.getLiveLayoutManager();
liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, (roomId, layoutInfo) => {
console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
});

参数
类型
说明
roomId
String
房间 ID。
layoutInfo
String
最新的画面布局信息。

onSeatLayoutChanged

麦位排版信息发生变化事件。
const roomEngine = new TUIRoomEngine();
const liveLayoutManager = roomEngine.getLiveLayoutManager();
liveLayoutManager.on(TUILiveLayoutManagerEvents.onSeatLayoutChanged, ({ roomId, seatLayout }) => {
console.log('liveLayoutManager.onSeatLayoutChanged', roomId, seatLayout);
});

参数
类型
说明
options
Object
参数选项。
options.roomId
String
房间 ID。
options.seatLayout
麦位排版信息。

类型定义详情

TUISeatLayout

属性
类型
说明
templateId
Number
麦位排版模板 ID。
canvasWidth
Number
麦位排版画布宽度。
canvasHeight
Number
麦位排版画布高度。
regions
麦位排版区域列表。

TUISeatRegion

属性
类型
说明
roomId
String
直播间 ID。
seatIndex
Number
麦位序号。
isSeatLocked
Boolean
是否被锁定。
userId
String
用户 ID。
userName
String
用户名称。
userAvatar
String
用户头像。
userMicrophoneStatus
用户麦克风状态。
userCameraStatus
用户摄像头状态。
x
Number
麦位 X 坐标。
y
Number
麦位 Y 坐标。
width
Number
麦位宽度。
height
Number
麦位高度。
zorder
Number
麦位 Z 轴顺序。

TUIDeviceStatus

属性
类型
说明
TUIDeviceStatusOpened
Number
当前设备处于打开状态。
TUIDeviceStatusClosedBySelf
Number
当前设备处于关闭状态,且是用户主动关闭。
TUIDeviceStatusClosedByAdmin
Number
当前设备处于关闭状态,且是被房主/管理员强制关闭。


帮助和支持

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

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

文档反馈