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&MacRoomKit API（iOS）

RoomKit API（iOS）

PDF
聚焦模式
字号
最后更新时间： 2024-03-15 16:08:25

简介

TUIRoomKit 是多人视频会议 SDK 提供的上层 UI 开源套件，目前 iOS 平台仅支持 Swift 语言，通过简单 API 调用即可唤起会议 UI。

TUIRoomKit 接口

API
描述
初始化 TUIRoomKit 单例对象
销毁 TUIRoomKit 单例对象
设置用户信息（头像、昵称）（可选）
创建房间
enterRoom
进入房间

createInstance

初始化 TUIRoomKit 单例对象。
public class func createInstance() -> TUIRoomKit

destroyInstance

销毁 TUIRoomKit 单例对象。
public class func destroyInstance() -> Void

setSelfInfo（可选）

设置用户信息（头像、昵称）。
public func setSelfInfo(userName: String, 
                       avatarURL: String, 
                       onSuccess: @escaping TUISuccessBlock, 
                         onError: @escaping TUIErrorBlock) -> Void
参数
类型
含义
userName
String
用户名
avatarURL
String
用户头像链接
onSuccess
TUISuccessBlock
成功回调
onError
TUIErrorBlock
失败回调

createRoom

创建房间。
public func createRoom(roomInfo: TUIRoomInfo, 
                      onSuccess: @escaping TUISuccessBlock, 
                        onError: @escaping TUIErrorBlock) -> Void
参数含义如下表所示：
参数
类型
含义
roomInfo
房间基本信息
onSuccess
TUISuccessBlock
成功回调
onError
TUIErrorBlock
失败回调

enterRoom

进入房间。
public func enterRoom(roomId: String, 
                 enableAudio: Bool, 
                 enableVideo: Bool, 
            isSoundOnSpeaker: Bool,
                   onSuccess: @escaping TUISuccessBlock, 
                     onError: @escaping TUIErrorBlock) -> Void
参数含义如下表所示：
参数
类型
含义
roomId
String
房间号字符串
enableAudio
Bool
进入房间是否开启音频
enableVideo
Bool
进入房间是否开启视频
isSoundOnSpeaker
Bool
进入房间是否开启扬声器
onSuccess
TUISuccessBlock
成功回调
onError
TUIErrorBlock
失败回调

上一篇: 监听会议状态下一篇: API 概览

帮助和支持

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

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

文档反馈