API 概览

最近更新时间:2024-04-26 14:53:11

我的收藏

TUIRoomKit(含 UI 组件)

API
描述
获取 roomEngine 实例。如果 roomEngine 不存在,则返回 null。
on
监听指定类型的事件。当事件发生时,将调用回调函数。
off
取消监听指定类型的事件。
login
登录会议系统。
logout
登出会议系统。
start
开始一个新的会议。
join
加入一个已经存在的会议。
leave
离开当前会议。
dismiss
解散当前会议。
设置自己的用户信息。
设置界面语言。
setTheme
设置界面主题。
禁用应用程序中的文本消息功能。调用此函数后,用户将无法发送或接收文本消息。
禁用应用程序中的屏幕共享功能。调用此函数后,用户将无法与他人共享屏幕。
隐藏应用程序中的特定功能按钮。调用此函数并传入适当的 FeatureButton 枚举值后,相应的按钮将从用户界面中隐藏。

TUIRoomEngine (无 UI 接口)

TUIRoomEngine 接口列表

TUIRoomEngine 静态方法
API
描述
once
监听 TUIRoomEngine ready 事件。
注意:
TUIRoomEngine.init 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.init 方法执行成功后执行。
login
登录 TUIRoomEngine。
设置当前用户基本信息(用户名、用户头像)。
获取当前用户基本信息(用户名、用户头像)。
logout
登出 TUIRoomEngine。
roomEngine 房间管理 API
API
描述
创建房间。
enterRoom
进入房间。
销毁房间。
exitRoom
离开房间。
获取房间信息。
更新房间的名字(仅群主或者管理员可以调用)。
更新房间的发言模式(仅群主或者管理员可以调用),该接口自 v2.0.0 版本废弃。
更新房间上麦模式(仅群主或者管理员可以调用)。
获取当前房间用户列表。
获取用户的详细信息。
roomEngine 音视频 API
API
描述
设置本地流的渲染位置。
本地摄像头视频流采集。
关闭本地摄像头。
打开本地麦克风。
关闭本地麦克风。
设置本地视频的参数。
设置本地音频的参数。
开始屏幕共享。
停止屏幕共享。
开始向远端推本地视频流。
停止向远端推本地视频流。
开始向远端推本地音频流。
停止向远端推本地音频流。
开始向远端推本地音频流。
停止向远端推本地音频流。
设置远端流渲染的区域。
开始播放远端用户视频流。
停止播放远端用户视频流。
停止远端用户的音频流。
roomEngine 成员管理 API
API
描述
请求远端用户打开媒体设备。
参会者向主持人申请打开设备。
关闭远端用户媒体设备。
取消已经发出的请求。
回复远端用户的请求。
改变用户的角色。
将用户踢出房间。
禁用/打开所有用户的媒体设备。
禁止/允许所有用户发送消息。
禁止/允许某个用户发送消息。
roomEngine 麦位管理 API
API
描述
设置房间麦位最大值。
获取麦位信息。
takeSeat
获取麦位。
leaveSeat
释放麦位。
邀请其他人上麦(仅房间主持人和管理员可调用此方法)。
将其他人踢下麦(仅房间主持人和管理员可调用此方法)。
锁定某个麦位状态(仅房间主持人和管理员可调用此方法)。
获取上麦请求列表,该接口自 v2.1.0 版本支持(仅房间主持人和管理员可调用此方法)。
roomEngine 消息发送 API(该模块自 v2.0.0 版本废弃,聊天模块请使用 chat 实例实现)
API
描述
发送文本消息,该接口自 v2.0.0 版本废弃。
发送自定义消息,该接口自 v2.0.0 版本废弃。
roomEngine 设备管理 API
API
描述
获取摄像头设备列表。
获取麦克风设备列表。
获取扬声器设备列表。
设置要使用的摄像头设备。
设置要使用的麦克风设备。
设置要使用的扬声器设备。
获取当前正在使用的摄像头设备。
获取当前正在使用的麦克风设备。
获取当前正在使用的扬声器设备。
开始进行摄像头测试。
停止摄像头测试。
roomEngine 事件监听 API
API
描述
on
监听 TUIRoomEvents 事件。
off
取消监听 TUIRoomEvents 事件。
roomEngine 其他 API
API
描述
获取 TRTCCloud 实例。
getTIM
获取 TIM 实例。

TUIRoomEngine 事件类型

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