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 政策
隐私协议
数据处理和安全协议
词汇表
文档实时音视频视频会议 SDK客户端 API（TUIRoomKit）ElectronRoomEngine APIAPI 概览

API 概览

PDF
聚焦模式
字号
最后更新时间： 2024-02-29 10:59:49

TUIRoomEngine (无 UI 接口)

TUIRoomEngine 静态方法

API
描述
once
监听 TUIRoomEngine ready 事件。
注意：TUIRoomEngine.init 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.init 方法执行成功后执行
login
登录 TUIRoomEngine
设置当前用户基本信息（用户名、用户头像）
获取当前用户基本信息（用户名、用户头像）
logout
登出 TUIRoomEngine

roomEngine 房间管理 API

API
描述
创建房间
enterRoom
进入房间
销毁房间
exitRoom
离开房间
获取房间信息
更新房间的名字（仅群主或者管理员可以调用）
更新房间的发言模式（仅群主或者管理员可以调用）
获取当前房间用户列表
获取用户的详细信息

roomEngine 音视频 API

API
描述
设置本地流的渲染位置
本地摄像头视频流采集
关闭本地摄像头
打开本地麦克风
关闭本地麦克风
设置本地视频的参数
设置本地音频的参数
开始向远端推本地视频流
停止向远端推本地视频流
开始向远端推本地音频流
停止向远端推本地音频流
设置远端流渲染的区域
开始播放远端用户视频流
停止播放远端用户视频流
停止远端用户的音频流

roomEngine 成员管理 API

API
描述
请求远端用户打开媒体设备
参会者向主持人申请打开设备
关闭远端用户媒体设备
取消已经发出的请求
回复远端用户的请求
改变用户的角色
将用户踢出房间
禁用/打开所有用户的媒体设备
禁止/允许所有用户发送消息
禁止/允许某个用户发送消息

roomEngine 屏幕分享 API

API
描述
开始屏幕共享
停止屏幕共享
获取屏幕分享列表
切换屏幕分享窗口

roomEngine 麦位管理API

API
描述
设置房间麦位最大值
获取麦位信息
takeSeat
获取麦位
leaveSeat
释放麦位
邀请其他人上麦（仅房间主持人和管理员可调用此方法）
将其他人踢下麦（仅房间主持人和管理员可调用此方法）
锁定某个麦位状态（仅房间主持人和管理员可调用此方法）

roomEngine 消息发送 API

API
描述
发送文本消息
发送自定义消息

roomEngine 设备管理 API

API
描述
获取摄像头设备列表
获取麦克风设备列表
获取扬声器设备列表
设置要使用的摄像头设备
设置要使用的麦克风设备
设置要使用的扬声器设备
获取当前正在使用的摄像头设备
获取当前正在使用的麦克风设备
获取当前正在使用的扬声器设备
开始进行摄像头测试
停止摄像头测试

roomEngine 事件监听 API

API
描述
on
监听 TUIRoomEvents 事件
off
取消监听 TUIRoomEvents 事件

roomEngine 其他 API

API
描述
获取 trtcCloud 实例
getTIM
获取 tim 实例

事件类型定义

TUIRoomEvent 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己感兴趣的回调事件。
EVENT
描述
错误事件
踢出房间事件
当前用户被踢下线
userSig 过期事件
主持人销毁房间事件
房间名称修改事件
房间发言模式修改事件
所有成员摄像头使用权限改变事件
所有成员麦克风使用权限改变事件
所有成员发送消息状态改变事件
房间最大麦位数修改事件
远端用户进入房间事件
远端用户离开房间事件
用户角色改变事件
用户视频状态改变事件
用户音频状态改变事件
用户发送消息状态事件
用户音量改变事件
用户网络质量改变事件
麦位列表改变事件
用户被踢下麦事件
请求接收事件
请求取消事件
接收文本消息事件
接收自定义消息事件
设备变更事件
屏幕分享停止事件，当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时，该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。

上一篇: RoomKit API下一篇: TUIRoomEngine

帮助和支持

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

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

文档反馈