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）iOS&MacRoomEngine APIAPI 概览

API 概览

PDF
聚焦模式
字号
最后更新时间： 2025-07-18 14:22:48
API OVERVIEW

创建实例和事件回调。

函数列表
描述
获取 TUIRoomEngine 单例实例。
销毁 TUIRoomEngine 单例实例。
登录接口，初始化用户信息后才能进入房间并进行操作。
退出登录接口，释放资源并离开房间。
设置本地用户名称和头像。
获取本地用户登录的基本信息。
设置当前登录用户的详细信息。
设置事件回调。
移除事件回调。

房间相关主动接口

函数列表
描述
创建房间。
解散房间。
进入房间。
进入房间。
进入房间。
离开房间。
获取当前进入的房间信息。
获取指定的房间信息。
更新房间名称（只有管理员或房主能够调用）。
更新房间麦位模式（只有管理员或房主能够调用）。
更新房间密码（管理员或房主专用）。
获取房间自定义信息。
设置房间自定义信息（直播房间专用）。

本地用户视图渲染、视频管理

函数列表
描述
设置本地用户视频渲染的视图控件
打开本地摄像头
关闭本地摄像头
开始推送本地视频。默认开启
停止推送本地视频
更新本地视频编码质量设置
设置视频编码器的编码参数
设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）
设置本地画面被暂停期间的替代图片
开启重力感应模式
开始屏幕分享（该接口仅支持移动端）
开始屏幕分享（该接口仅支持桌面端 Mac OS 系统）
结束屏幕分享
枚举可分享的屏幕和窗口（该接口仅支持 Mac OS 系统）
选取要分享的屏幕或窗口（该接口仅支持 Mac OS 系统）

本地用户音频管理

函数列表
描述
打开本地麦克风
关闭本地麦克风
更新本地音频编码质量设置
暂停发布本地的音频流
恢复发布本地的音频流
开启系统声音分享

远端用户视图渲染、视频管理

函数列表
描述
设置远端用户视频渲染的视图控件
开始播放远端用户视频
停止播放远端用户视频
将远端用户静音

房间内用户信息

函数列表
描述
获取房间内的成员列表
获取成员信息
搜索成员信息

房间内用户管理

函数列表
描述
修改用户角色（只有管理员或房主能够调用）
修改用户房间内昵称
将远端用户踢出房间（只有管理员或房主能够调用）
为用户增加标记（只有房主能够调用）
为用户移除标记（只有房主能够调用）
根据标记获取房间内用户信息
设置房间内成员自定义信息

房间内用户发言管理

函数列表
描述
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头（目前仅会议场景下可用，并且只有管理员或房主能够调用）
请求远端用户打开媒体设备（只有管理员或房主能够调用,device类型不支持SCREEN_SHARING）
关闭远端用户媒体设备（只有管理员或房主能够调用）
请求打开本地媒体设备（普通用户可用,device类型不支持SCREEN_SHARING）

房间内麦位管理

函数列表
描述
获取麦位列表
锁定麦位（只有管理员或房主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）
上麦（上麦发言模式下，需要申请）
下麦
移麦
主持人/管理员 邀请用户上麦
主持人/管理员 将用户踢下麦
主持人/管理员 获取房间内申请上麦用户的请求列表

房间内消息

函数列表
描述
禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）
禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）
发送文本消息
发送自定义消息

信令管理

函数列表
描述
取消请求
回复请求

高级功能

函数列表
描述
获得TRTC实例对象
设置美颜级别
设置美白级别
获取插件
获取设备管理类
获取连线管理类
获取 Battle 管理类

调试相关

函数列表
描述
调用实验性接口

错误事件回调

函数列表
描述
错误事件回调

登录状态事件回调

函数列表
描述
用户被踢下线
用户凭证超时事件

房间内事件回调

函数列表
描述
房间名称更改事件
房间内所有用户麦克风被禁用事件
房间内所有用户摄像头被禁用事件
房间内所有用户屏幕分享被禁用事件
房间内用户发送文本消息被禁用事件
房间被解散事件
被踢出房间事件
房间上麦模式发生变化
房间内人员数量发生变化
房间内自定义信息发生变化

房间内用户事件回调

函数列表
描述
远端用户进房事件
远端用户离开房间事件
房间内用户信息发生变化事件。
用户视频状态发生变化事件
用户音频状态发生变化事件
用户音量变化事件
用户文本消息发送能力发生变化事件
用户网络状态变化事件
屏幕分享暂停
屏幕分享恢复
屏幕分享结束
用户视频大小发生改变

房间内麦位事件回调

函数列表
描述
麦位列表发生变化事件
收到用户被踢下麦事件

请求信令事件回调

函数列表
描述
收到请求消息事件
收到请求被取消的事件
收到请求被其他 管理员/房主 处理事件
收到了文本消息

房间内消息回调

函数列表
描述
收到请求消息事件
收到了文本消息
收到了自定义消息

废弃回调

函数列表
描述
本地设备添加事件
上一篇: RoomKit API（iOS）下一篇: TUIRoomEngine

帮助和支持

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

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

文档反馈