API 概览

最近更新时间:2024-09-24 15:31:01

我的收藏

TUIRoomEngine

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
释放麦位
邀请其他人上麦(仅房间主持人和管理员可调用此方法)
将其他人踢下麦(仅房间主持人和管理员可调用此方法)
获取上麦请求列表,该接口自 v2.1.0 版本支持(仅房间主持人和管理员可调用此方法)

roomEngine 事件监听 API

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

roomEngine 其他 API

API
描述
获取 TRTCCloud 实例
getTIM
获取 TIM 实例

事件类型定义

TUIRoomEvent 是 TUIRoomEngine 对应的回调事件类,您可以通过此回调,来监听自己感兴趣的回调事件。
EVENT
描述
错误事件
踢出房间事件
用户被踢下麦事件
当前用户被踢下线
userSig 过期事件
主持人销毁房间事件
房间名称修改事件
房间信息修改事件
上麦模式修改事件
所有成员麦克风使用权限改变事件
所有成员发送消息状态改变事件
房间最大麦位数修改事件
远端用户进入房间事件
远端用户离开房间事件
用户角色改变事件
用户视频状态改变事件
用户音频状态改变事件
用户发送消息状态事件
用户音量改变事件
用户网络质量改变事件
麦位控制启用事件
麦位列表改变事件
请求接收事件
请求被处理事件
请求取消事件
设备变更事件
屏幕分享停止事件