Docs Overview/
API 概览/

API 概览

API OVERVIEW

创建实例和事件回调

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

房间相关主动接口

函数列表
描述
创建房间
解散房间
进入房间
离开房间
获取当前进入的房间信息
更新房间名称（只有管理员或房主能够调用）
更新房间麦位模式（只有管理员或房主能够调用）
更新房间密码
获取房间自定义信息
设置房间自定义信息，已有该属性则更新其 value 值，没有则添加该属性

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

函数列表
描述
设置本地用户视频渲染的视图控件
打开本地摄像头
关闭本地摄像头
开始推送本地视频。默认开启
停止推送本地视频
更新本地视频编码质量设置
设置视频编码器的编码参数
设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）
开启重力感应模式
开始屏幕分享（该接口仅支持移动端）
结束屏幕分享

本地用户音频管理

函数列表
描述
打开本地麦克风
关闭本地麦克风
更新本地音频编码质量设置
暂停发布本地的音频流
恢复发布本地的音频流
开启系统声音分享

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

函数列表
描述
设置远端用户视频渲染的视图控件
开始播放远端用户视频
停止播放远端用户视频
将远端用户静音

房间内用户信息

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

房间内用户管理

函数列表
描述
修改用户角色（只有管理员或房主能够调用）
修改用户房间内昵称
将远端用户踢出房间（只有管理员或房主能够调用）
为用户增加标记（只有房主能够调用）
为用户移除标记（只有房主能够调用）
根据标记获取房间内用户信息
设置房间内成员自定义信息

房间内用户发言管理

函数列表
描述
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头（目前仅会议场景下可用，并且只有管理员或房主能够调用）
请求远端用户打开媒体设备（只有管理员或房主能够调用,device类型不支持SCREEN_SHARING）
关闭远端用户媒体设备（只有管理员或房主能够调用）
请求打开本地媒体设备（普通用户可用,device类型不支持SCREEN_SHARING）

房间内麦位管理

函数列表
描述
设置最大麦位数（仅支持进房前和创建房间时设置）
获取麦位列表
锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）
上麦（上麦发言模式下，需要申请）
下麦
移麦
主持人/管理员 邀请用户上麦
主持人/管理员 将用户下麦
主持人/管理员 获取房间内申请上麦用户的请求列表

文本消息

函数列表
描述
禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）
禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）

信令管理

函数列表
描述
取消请求
回复请求

高级功能

函数列表
描述
设置美颜级别
设置美白级别
获取插件
获取设备管理类
获取连线管理类
获取 Battle 管理类

调试相关

函数列表
描述
调用实验性接口

错误事件回调

函数列表
描述
错误事件回调

登录状态事件回调

函数列表
描述
用户被踢下线
用户凭证超时事件

房间内事件回调

函数列表
描述
房间名称更改事件
房间内所有用户麦克风被禁用事件
房间内所有用户摄像头被禁用事件
房间内所有用户屏幕分享被禁用事件
房间内用户发送文本消息被禁用事件
房间被解散事件
被踢出房间事件
房间上麦模式发生变化
房间内人员数量发生变化
房间内自定义信息发生变化

房间内用户事件回调

函数列表
描述
远端用户进房事件
远端用户离开房间事件
房间内用户信息发生变化事件。
用户视频状态发生变化事件
用户音频状态发生变化事件
用户音量变化事件
用户文本消息发送能力发生变化事件
用户网络状态变化事件
屏幕分享结束

房间内麦位事件回调

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

请求信令事件回调

函数列表
描述
收到请求消息事件
收到请求被取消的事件
收到请求被其他 管理员/房主 处理事件

废弃回调

函数列表
描述
房间被解散事件
收到用户被踢下麦事件
收到请求被取消的事件
收到请求被其他 管理员/房主 处理事件
用户角色发生变化事件

设备管理相关接口

函数列表
描述
判断当前是否为前置摄像头（仅支持移动端）
切换前置或后置摄像头（仅支持移动端）
查询是否支持自动识别人脸位置（仅支持移动端）
开启自动对焦功能（仅支持移动端）
开启/关闭闪光灯，也就是手电筒模式（仅支持移动端）
设置音频路由（仅支持移动端）