API 概览

最近更新时间:2023-10-19 18:23:48

我的收藏

TUIRoomKit (含 UI 组件)

TUIRoomKit 接口列表

API
描述
init
初始化 TUIRoomKit 组件
主持人创建房间
enterRoom
普通成员加入房间

TUIRoomKit 事件类型

事件
描述
创建房间回调
进入房间回调
销毁房间回调
普通成员退出房间回调
普通成员被主持人移出房间通知
用户账号在其他地方登录,被移下线
用户 userSig 过期,请重新获取 userSig

TUIRoomEngine (无 UI 接口)

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
描述
设置房间麦位最大值
获取麦位信息
takeSeat
获取麦位
leaveSeat
释放麦位
邀请其他人上麦(仅房间主持人和管理员可调用此方法)
将其他人移下麦(仅房间主持人和管理员可调用此方法)
锁定某个麦位状态(仅房间主持人和管理员可调用此方法)
roomEngine 消息发送 API
API
描述
发送文本消息
发送自定义消息
roomEngine 事件监听 API
API
描述
on
监听 TUIRoomEvents 事件
off
取消监听 TUIRoomEvents 事件
roomEngine 其他 API
API
描述
获取 trtcCloud 实例
getTIM
获取 tim 实例

TUIRoomEngine 事件类型

TUIRoomEvent 是 TUIRoomEngine 对应的回调事件类,您可以通过此回调,来监听自己感兴趣的回调事件。
EVENT
描述
错误事件
移出房间事件
当前用户被移下线事件
userSig 过期事件
主持人销毁房间事件
房间名称修改事件
房间发言模式修改事件
所有成员摄像头使用权限改变事件
所有成员麦克风使用权限改变事件
所有成员发送消息状态改变事件
房间最大麦位数修改事件
远端用户进入房间事件
远端用户离开房间事件
用户角色改变事件
用户视频状态改变事件
用户音频状态改变事件
用户发送消息状态事件
用户音量改变事件
用户网络质量改变事件
麦位列表改变事件
用户被移下麦事件
请求接收事件
请求取消事件
接收文本消息事件
接收自定义消息事件