API 概览

最近更新时间：2024-04-19 19:04:22

我的收藏

本页目录：

TUIRoomKit (含 UI 组件)
- - TUIRoomKit 接口列表
  - TUIRoomKit 事件类型
TUIRoomEngine (无 UI 接口)
- - TUIRoomEngine 接口列表
  - TUIRoomEngine 事件类型

TUIRoomKit (含 UI 组件)
TUIRoomKit 接口列表
API
描述
﻿init﻿
初始化 TUIRoomKit 组件
﻿createRoom﻿
主持人创建房间
﻿enterRoom﻿
普通成员加入房间
TUIRoomKit 事件类型
事件
描述
﻿onCreateRoom﻿
创建房间回调
﻿onEnterRoom﻿
进入房间回调
﻿onDestroyRoom﻿
销毁房间回调
﻿onExitRoom﻿
普通成员退出房间回调
﻿onKickedOutOfRoom﻿
普通成员被主持人移出房间通知
﻿onKickedOffLine﻿
用户账号在其他地方登录，被移下线
﻿onUserSigExpired﻿
用户 userSig 过期，请重新获取 userSig
TUIRoomEngine (无 UI 接口)
TUIRoomEngine 接口列表
TUIRoomEngine 静态方法
API
描述
﻿once﻿
监听 TUIRoomEngine ready 事件。
注意：TUIRoomEngine.init 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.init 方法执行成功后执行。
﻿login﻿
登录 TUIRoomEngine
﻿setSelfInfo﻿
设置当前用户基本信息（用户名、用户头像）
﻿getSelfInfo﻿
获取当前用户基本信息（用户名、用户头像）
﻿logout﻿
登出 TUIRoomEngine
roomEngine 房间管理 API
API
描述
﻿createRoom﻿
创建房间
﻿enterRoom﻿
进入房间
﻿destroyRoom﻿
销毁房间
﻿exitRoom﻿
离开房间
﻿fetchRoomInfo﻿
获取房间信息
﻿updateRoomNameByAdmin﻿
更新房间的名字（仅群主或者管理员可以调用）
﻿updateRoomSpeechModeByAdmin﻿
更新房间的发言模式（仅群主或者管理员可以调用），该接口自 v2.0.0 版本废弃
﻿updateRoomSeatModeByAdmin﻿
更新房间上麦模式（仅群主或者管理员可以调用）
﻿getUserList﻿
获取当前房间用户列表
﻿getUserInfo﻿
获取用户的详细信息
roomEngine 音视频 API
API
描述
﻿setLocalVideoView﻿
设置本地流的渲染位置
﻿openLocalCamera﻿
本地摄像头视频流采集
﻿closeLocalCamera﻿
关闭本地摄像头
﻿openLocalMicrophone﻿
打开本地麦克风
﻿closeLocalMicrophone﻿
关闭本地麦克风
﻿updateVideoQuality﻿
设置本地视频的参数
﻿updateAudioQuality﻿
设置本地音频的参数
﻿startPushLocalVideo﻿
开始向远端推本地视频流
﻿stopPushLocalVideo﻿
停止向远端推本地视频流
﻿startPushLocalAudio﻿
开始向远端推本地音频流
﻿stopPushLocalAudio﻿
停止向远端推本地音频流
﻿muteLocalAudio﻿
停止向远端推本地音频流
﻿unmuteLocalAudio﻿
开始向远端推本地音频流
﻿setRemoteVideoView﻿
设置远端流渲染的区域
﻿startPlayRemoteVideo﻿
开始播放远端用户视频流
﻿stopPlayRemoteVideo﻿
停止播放远端用户视频流
﻿muteRemoteAudioStream﻿
停止远端用户的音频流
roomEngine 成员管理 API
API
描述
﻿openRemoteDeviceByAdmin﻿
请求远端用户打开媒体设备
﻿applyToAdminToOpenLocalDevice﻿
参会者向主持人申请打开设备
﻿closeRemoteDeviceByAdmin﻿
关闭远端用户媒体设备
﻿cancelRequest﻿
取消已经发出的请求
﻿responseRemoteRequest﻿
回复远端用户的请求
﻿changeUserRole﻿
改变用户的角色
﻿kickRemoteUserOutOfRoom﻿
将用户移出房间
﻿disableDeviceForAllUserByAdmin﻿
禁用/打开所有用户的媒体设备
﻿disableSendingMessageForAllUser﻿
禁止/允许所有用户发送消息
﻿disableSendingMessageByAdmin﻿
禁止/允许某个用户发送消息
﻿setCustomInfoForUser﻿
设置用户的自定义信息
roomEngine 麦位管理 API
API
描述
﻿setMaxSeatCount﻿
设置房间麦位最大值
﻿getSeatList﻿
获取麦位信息
﻿takeSeat﻿
获取麦位
﻿leaveSeat﻿
释放麦位
﻿takeUserOnSeatByAdmin﻿
邀请其他人上麦（仅房间主持人和管理员可调用此方法）
﻿kickUserOffSeatByAdmin﻿
将其他人移下麦（仅房间主持人和管理员可调用此方法）
﻿lockSeatByAdmin﻿
锁定某个麦位状态（仅房间主持人和管理员可调用此方法）
﻿getSeatApplicationList﻿
获取上麦请求列表，该接口自 v2.1.0 版本支持（仅房间主持人和管理员可调用此方法）
roomEngine 消息发送 API（该模块自 v2.0.0 版本废弃，聊天模块请使用 chat 实例实现）
API
描述
﻿sendTextMessage﻿
发送文本消息，该接口自 v2.0.0 版本废弃
﻿sendCustomMessage﻿
发送自定义消息，该接口自 v2.0.0 版本废弃
roomEngine 事件监听 API
API
描述
﻿on﻿
监听 TUIRoomEvents 事件
﻿off﻿
取消监听 TUIRoomEvents 事件
roomEngine 其他 API
API
描述
﻿getTRTCCloud﻿
获取 trtcCloud 实例
﻿getTIM﻿
获取 tim 实例
TUIRoomEngine 事件类型
TUIRoomEvent 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己感兴趣的回调事件。
EVENT
描述
﻿TUIRoomEvents.onError﻿
错误事件
﻿TUIRoomEvents.onKickedOutOfRoom﻿
移出房间事件
﻿TUIRoomEvents.onKickedOffLine﻿
当前用户被移下线事件
﻿TUIRoomEvents.onUserSigExpired﻿
userSig 过期事件
﻿TUIRoomEvents.onRoomDismissed﻿
主持人销毁房间事件
﻿TUIRoomEvents.onRoomNameChanged﻿
房间名称修改事件
﻿TUIRoomEvents.onRoomSpeechModeChanged﻿
房间发言模式修改事件，该接口自 v2.0.0 版本废弃
﻿TUIRoomEvents.onRoomSeatModeChanged﻿
上麦模式修改事件
﻿TUIRoomEvents.onAllUserCameraDisableChanged﻿
所有成员摄像头使用权限改变事件
﻿TUIRoomEvents.onAllUserMicrophoneDisableChanged﻿
所有成员麦克风使用权限改变事件
﻿TUIRoomEvents.onSendMessageForAllUserDisableChanged﻿
所有成员发送消息状态改变事件
﻿TUIRoomEvents.onRoomMaxSeatCountChanged﻿
房间最大麦位数修改事件
﻿TUIRoomEvents.onRemoteUserEnterRoom﻿
远端用户进入房间事件
﻿TUIRoomEvents.onRemoteUserLeaveRoom﻿
远端用户离开房间事件
﻿TUIRoomEvents.onUserRoleChanged﻿
用户角色改变事件
﻿TUIRoomEvents.onUserVideoStateChanged﻿
用户视频状态改变事件
﻿TUIRoomEvents.onUserAudioStateChanged﻿
用户音频状态改变事件
﻿TUIRoomEvents.onSendMessageForUserDisableChanged﻿
用户发送消息状态事件
﻿TUIRoomEvents.onUserVoiceVolumeChanged﻿
用户音量改变事件
﻿TUIRoomEvents.onUserNetworkQualityChanged﻿
用户网络质量改变事件
﻿TUIRoomEvents.onSeatListChanged﻿
麦位列表改变事件
﻿TUIRoomEvents.onKickedOffSeat﻿
用户被移下麦事件
﻿TUIRoomEvents.onRequestReceived﻿
请求接收事件
﻿TUIRoomEvents.onRequestProcessed﻿
请求被处理事件
﻿TUIRoomEvents.onRequestCancelled﻿
请求取消事件
﻿TUIRoomEvents.onReceiveTextMessage﻿
接收文本消息事件，该接口自 v2.0.0 版本废弃
﻿TUIRoomEvents.onReceiveCustomMessage﻿
接收自定义消息事件
﻿

上一篇: RoomKit API 下一篇: TUIRoomEngine

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

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

API	描述
once	监听 TUIRoomEngine ready 事件。注意：TUIRoomEngine.init 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.init 方法执行成功后执行。
login	登录 TUIRoomEngine
setSelfInfo	设置当前用户基本信息（用户名、用户头像）
getSelfInfo	获取当前用户基本信息（用户名、用户头像）
logout	登出 TUIRoomEngine

API	描述
createRoom	创建房间
enterRoom	进入房间
destroyRoom	销毁房间
exitRoom	离开房间
fetchRoomInfo	获取房间信息
updateRoomNameByAdmin	更新房间的名字（仅群主或者管理员可以调用）
~~updateRoomSpeechModeByAdmin~~	更新房间的发言模式（仅群主或者管理员可以调用），该接口自 v2.0.0 版本废弃
updateRoomSeatModeByAdmin	更新房间上麦模式（仅群主或者管理员可以调用）
getUserList	获取当前房间用户列表
getUserInfo	获取用户的详细信息

API	描述
setLocalVideoView	设置本地流的渲染位置
openLocalCamera	本地摄像头视频流采集
closeLocalCamera	关闭本地摄像头
openLocalMicrophone	打开本地麦克风
closeLocalMicrophone	关闭本地麦克风
updateVideoQuality	设置本地视频的参数
updateAudioQuality	设置本地音频的参数
startPushLocalVideo	开始向远端推本地视频流
stopPushLocalVideo	停止向远端推本地视频流
startPushLocalAudio	开始向远端推本地音频流
stopPushLocalAudio	停止向远端推本地音频流
muteLocalAudio	停止向远端推本地音频流
unmuteLocalAudio	开始向远端推本地音频流
setRemoteVideoView	设置远端流渲染的区域
startPlayRemoteVideo	开始播放远端用户视频流
stopPlayRemoteVideo	停止播放远端用户视频流
muteRemoteAudioStream	停止远端用户的音频流

API	描述
openRemoteDeviceByAdmin	请求远端用户打开媒体设备
applyToAdminToOpenLocalDevice	参会者向主持人申请打开设备
closeRemoteDeviceByAdmin	关闭远端用户媒体设备
cancelRequest	取消已经发出的请求
responseRemoteRequest	回复远端用户的请求
changeUserRole	改变用户的角色
kickRemoteUserOutOfRoom	将用户移出房间
disableDeviceForAllUserByAdmin	禁用/打开所有用户的媒体设备
disableSendingMessageForAllUser	禁止/允许所有用户发送消息
disableSendingMessageByAdmin	禁止/允许某个用户发送消息
setCustomInfoForUser	设置用户的自定义信息

API	描述
setMaxSeatCount	设置房间麦位最大值
getSeatList	获取麦位信息
takeSeat	获取麦位
leaveSeat	释放麦位
takeUserOnSeatByAdmin	邀请其他人上麦（仅房间主持人和管理员可调用此方法）
kickUserOffSeatByAdmin	将其他人移下麦（仅房间主持人和管理员可调用此方法）
lockSeatByAdmin	锁定某个麦位状态（仅房间主持人和管理员可调用此方法）
getSeatApplicationList	获取上麦请求列表，该接口自 v2.1.0 版本支持（仅房间主持人和管理员可调用此方法）

API	描述
~~sendTextMessage~~	发送文本消息，该接口自 v2.0.0 版本废弃
~~sendCustomMessage~~	发送自定义消息，该接口自 v2.0.0 版本废弃

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

API	描述
getTRTCCloud	获取 trtcCloud 实例
getTIM	获取 tim 实例

EVENT	描述
TUIRoomEvents.onError	错误事件
TUIRoomEvents.onKickedOutOfRoom	移出房间事件
TUIRoomEvents.onKickedOffLine	当前用户被移下线事件
TUIRoomEvents.onUserSigExpired	userSig 过期事件
TUIRoomEvents.onRoomDismissed	主持人销毁房间事件
TUIRoomEvents.onRoomNameChanged	房间名称修改事件
~~TUIRoomEvents.onRoomSpeechModeChanged~~	房间发言模式修改事件，该接口自 v2.0.0 版本废弃
TUIRoomEvents.onRoomSeatModeChanged	上麦模式修改事件
TUIRoomEvents.onAllUserCameraDisableChanged	所有成员摄像头使用权限改变事件
TUIRoomEvents.onAllUserMicrophoneDisableChanged	所有成员麦克风使用权限改变事件
TUIRoomEvents.onSendMessageForAllUserDisableChanged	所有成员发送消息状态改变事件
TUIRoomEvents.onRoomMaxSeatCountChanged	房间最大麦位数修改事件
TUIRoomEvents.onRemoteUserEnterRoom	远端用户进入房间事件
TUIRoomEvents.onRemoteUserLeaveRoom	远端用户离开房间事件
TUIRoomEvents.onUserRoleChanged	用户角色改变事件
TUIRoomEvents.onUserVideoStateChanged	用户视频状态改变事件
TUIRoomEvents.onUserAudioStateChanged	用户音频状态改变事件
TUIRoomEvents.onSendMessageForUserDisableChanged	用户发送消息状态事件
TUIRoomEvents.onUserVoiceVolumeChanged	用户音量改变事件
TUIRoomEvents.onUserNetworkQualityChanged	用户网络质量改变事件
TUIRoomEvents.onSeatListChanged	麦位列表改变事件
TUIRoomEvents.onKickedOffSeat	用户被移下麦事件
TUIRoomEvents.onRequestReceived	请求接收事件
TUIRoomEvents.onRequestProcessed	请求被处理事件
TUIRoomEvents.onRequestCancelled	请求取消事件
~~TUIRoomEvents.onReceiveTextMessage~~	接收文本消息事件，该接口自 v2.0.0 版本废弃
TUIRoomEvents.onReceiveCustomMessage	接收自定义消息事件