TUIRoomEngine (无 UI 接口)
TUIRoomEngine 静态方法
| once |
监听 TUIRoomEngine ready 事件。注意：TUIRoomEngine.init 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.init 方法执行成功后执行 |
| login |
登录 TUIRoomEngine |
| setSelfInfo |
设置当前用户基本信息（用户名、用户头像） |
| getSelfInfo |
获取当前用户基本信息（用户名、用户头像） |
| logout |
登出 TUIRoomEngine |
roomEngine 房间管理 API
| createRoom |
创建房间 |
| enterRoom |
进入房间 |
| destroyRoom |
销毁房间 |
| exitRoom |
离开房间 |
| fetchRoomInfo |
获取房间信息 |
| updateRoomNameByAdmin |
更新房间的名字（仅群主或者管理员可以调用） |
| updateRoomSpeechModeByAdmin |
更新房间的发言模式（仅群主或者管理员可以调用） |
| getUserList |
获取当前房间用户列表 |
| getUserInfo |
获取用户的详细信息 |
roomEngine 音视频 API
| setLocalVideoView |
设置本地流的渲染位置 |
| openLocalCamera |
本地摄像头视频流采集 |
| closeLocalCamera |
关闭本地摄像头 |
| openLocalMicrophone |
打开本地麦克风 |
| closeLocalMicrophone |
关闭本地麦克风 |
| muteLocalAudio |
停止向远端推本地音频流 |
| unmuteLocalAudio |
开始向远端推本地音频流 |
| updateVideoQuality |
设置本地视频的参数 |
| updateAudioQuality |
设置本地音频的参数 |
| startPushLocalVideo |
开始向远端推本地视频流 |
| stopPushLocalVideo |
停止向远端推本地视频流 |
| startPushLocalAudio |
开始向远端推本地音频流 |
| stopPushLocalAudio |
停止向远端推本地音频流 |
| setRemoteVideoView |
设置远端流渲染的区域 |
| startPlayRemoteVideo |
开始播放远端用户视频流 |
| stopPlayRemoteVideo |
停止播放远端用户视频流 |
| muteRemoteAudioStream |
停止远端用户的音频流 |
roomEngine 成员管理 API
| openRemoteDeviceByAdmin |
请求远端用户打开媒体设备 |
| applyToAdminToOpenLocalDevice |
参会者向主持人申请打开设备 |
| closeRemoteDeviceByAdmin |
关闭远端用户媒体设备 |
| cancelRequest |
取消已经发出的请求 |
| responseRemoteRequest |
回复远端用户的请求 |
| changeUserRole |
改变用户的角色 |
| kickRemoteUserOutOfRoom |
将用户踢出房间 |
| disableDeviceForAllUserByAdmin |
禁用/打开所有用户的媒体设备 |
| disableSendingMessageForAllUser |
禁止/允许所有用户发送消息 |
| disableSendingMessageByAdmin |
禁止/允许某个用户发送消息 |
roomEngine 屏幕分享 API
| startScreenSharingElectron |
开始屏幕共享 |
| stopScreenSharingElectron |
停止屏幕共享 |
| getScreenSharingTarget |
获取屏幕分享列表 |
| selectScreenSharingTarget |
切换屏幕分享窗口 |
roomEngine 麦位管理API
| setMaxSeatCount |
设置房间麦位最大值 |
| getSeatList |
获取麦位信息 |
| takeSeat |
获取麦位 |
| leaveSeat |
释放麦位 |
| takeUserOnSeatByAdmin |
邀请其他人上麦（仅房间主持人和管理员可调用此方法） |
| kickUserOffSeatByAdmin |
将其他人踢下麦（仅房间主持人和管理员可调用此方法） |
| lockSeatByAdmin |
锁定某个麦位状态（仅房间主持人和管理员可调用此方法） |
roomEngine 消息发送 API
| sendTextMessage |
发送文本消息 |
| sendCustomMessage |
发送自定义消息 |
roomEngine 设备管理 API
| getCameraDevicesList |
获取摄像头设备列表 |
| getMicDevicesList |
获取麦克风设备列表 |
| getSpeakerDevicesList |
获取扬声器设备列表 |
| setCurrentCameraDevice |
设置要使用的摄像头设备 |
| setCurrentMicDevice |
设置要使用的麦克风设备 |
| setCurrentSpeakerDevice |
设置要使用的扬声器设备 |
| getCurrentCameraDevice |
获取当前正在使用的摄像头设备 |
| getCurrentMicDevice |
获取当前正在使用的麦克风设备 |
| getCurrentSpeakerDevice |
获取当前正在使用的扬声器设备 |
| startCameraDeviceTest |
开始进行摄像头测试 |
| stopCameraDeviceTest |
停止摄像头测试 |
roomEngine 事件监听 API
| on |
监听 TUIRoomEvents 事件 |
| off |
取消监听 TUIRoomEvents 事件 |
roomEngine 其他 API
| getTRTCCloud |
获取 trtcCloud 实例 |
| getTIM |
获取 tim 实例 |
事件类型定义
TUIRoomEvent 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己感兴趣的回调事件。
| TUIRoomEvents.onError |
错误事件 |
| TUIRoomEvents.onKickedOutOfRoom |
踢出房间事件 |
| TUIRoomEvents.onKickedOffSeat |
用户被踢下麦事件 |
| TUIRoomEvents. onKickedOffLine |
当前用户被踢下线 |
| TUIRoomEvents.onUserSigExpired |
userSig 过期事件 |
| TUIRoomEvents.onRoomDismissed |
主持人销毁房间事件 |
| TUIRoomEvents.onRoomInfoChanged |
房间信息修改事件 |
| TUIRoomEvents.onRemoteUserEnterRoom |
远端用户进入房间事件 |
| TUIRoomEvents.onRemoteUserLeaveRoom |
远端用户离开房间事件 |
| TUIRoomEvents.onUserRoleChanged |
用户角色改变事件 |
| TUIRoomEvents.onUserMuteStateChanged |
用户禁止发文字消息状态改变事件 |
| TUIRoomEvents.onUserVideoStateChanged |
用户视频状态改变事件 |
| TUIRoomEvents.onUserAudioStateChanged |
用户音频状态改变事件 |
| TUIRoomEvents.onUserVoiceVolumeChanged |
用户音量改变事件 |
| TUIRoomEvents.onUserNetworkQualityChanged |
用户网络质量改变事件 |
| TUIRoomEvents.onSeatControlEnabled |
麦位控制启用事件 |
| TUIRoomEvents.onSeatListChanged |
麦位列表改变事件 |
| TUIRoomEvents.onRequestReceived |
请求接收事件 |
| TUIRoomEvents.onRequestCancelled |
请求取消事件 |
| TUIRoomEvents.onReceiveTextMessage |
接收文本消息事件 |
| TUIRoomEvents.onReceiveCustomMessage |
接收自定义消息事件 |
| TUIRoomEvents.onDeviceChange |
设备变更事件 |
| TUIRoomEvents.onUserScreenCaptureStopped |
屏幕分享停止事件，当用户使用浏览器自带的停止分享按钮结束屏幕共享时，该用户会收到 ‘onUserScreenCaptureStopped’ 事件用来修改屏幕共享状态 |
对音视频的解决方案有疑惑？想了解解决方案收费？ 联系解决方案专家
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心，购买腾讯云享受折上折，更有现金返利:同意关联，立享优惠
阿里云解决方案也看看？： 点击对比阿里云的解决方案
暂无评论，你要说点什么吗？