Docs Overview/
API 概览/

API 概览

TUIRoomEngine (无 UI 接口)

TUIRoomEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。
TUIRoomEngine

TUIRoomEngine 核心方法

API
描述
创建 TUIRoomEngine 实例
销毁 TUIRoomEngine 实例
login
登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
logout
退出登录接口，会有主动离开房间操作、销毁资源
设置本地用户名称和头像
获取本地用户基本信息
设置事件回调
移除事件回调

房间相关主动接口

API
描述
创建房间
解散房间
enterRoom
进入房间
exitRoom
离开房间
连接其他房间
断开与其他房间的连接
获取房间信息
更新房间名称
设置房间管理模式（只有管理员或群主能够调用）

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

API
描述
设置本地用户视频渲染的视图控件
打开本地摄像头
关闭本地摄像头
更新本地视频编码质量设置
开始屏幕分享
结束屏幕分享
开始推送本地视频
停止推送本地视频

本地用户音频管理

API
描述
打开本地麦克风
关闭本地麦克风
更新本地音频编码质量设置
开始推送本地音频
停止推送本地音频

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

API
描述
设置远端用户视频渲染的视图控件
开始播放远端用户视频
停止播放远端用户视频
将远端用户禁音

房间内用户信息

API
描述
获取房间内的成员列表
获取成员信息

房间内用户管理

API
描述
修改用户角色（只有管理员或群主能够调用）
将远端用户踢出房间（只有管理员或群主能够调用）

房间内用户发言管理

API
描述
全体用户媒体设备管理（只有管理员或群主能够调用）
请求远端用户打开媒体设备（只有管理员或群主能够调用）
关闭远端用户媒体设备（只有管理员或群主能够调用）
请求打开本地媒体设备（普通用户可用）

房间内麦位管理

API
描述
设置最大麦位数（仅支持进房前和创建房间时设置）
获取麦位列表
锁定麦位（包括位置锁定，音频状态锁定，视频状态锁定）
takeSeat
本地上麦
会议场景：SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦，其他模式不支持上麦。
直播场景：FREE_TO_SPEAK 模式可以自由上麦，上麦后开麦发言；SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦；其他模式不支持上麦
leaveSeat
本地下麦
主持人/管理员 邀请用户上麦
主持人/管理员 将用户下麦

信令管理

API
描述
取消请求
回复请求

发送消息

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

高级功能：获取 TRTC 实例

API
描述
获得 TRTC 实例对象
获得设备管理对象
获得音效管理对象
获得美颜管理对象


事件类型定义

TUIRoomObserver 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己需要的回调事件。
TUIRoomObserver

错误回调

事件
描述
onError
错误回调事件

登录状态事件回调

API
描述
用户被踢下线事件
用户凭证超时事件

房间内事件回调

API
描述
房间名称更改事件
房间内所有用户麦克风被禁用事件
房间内所有用户摄像头被禁用事件
房间内所有用户发送文本消息被禁用事件
房间被解散事件
被踢出房间事件
房间麦控模式发生变化

房间内用户事件回调

API
描述
远端用户进房事件
远端用户离开房间事件
用户角色发生变化事件
用户视频状态发生变化事件
用户音频状态发生变化事件
用户音量变化事件
用户文本消息发送能力发生变化事件
用户网络状态变化事件
屏幕分享结束事件

房间内麦位事件回调

API
描述
房间内最大麦位数发生变化事件（仅在会议类型房间生效）
麦位列表发生变化事件
收到用户被踢下麦事件

请求信令事件回调

API
描述
收到请求消息事件
收到请求被取消的事件

房间内消息事件回调

API
描述
收到普通文本消息事件
收到自定义消息事件