腾讯云实时音视频TUIRoomEngine_音视频解决方案_同尘科技

TUIRoomEngine 简介

TUIRoomEngine SDK 提供了房间管理，多人实时音视频互动，屏幕分享，成员管理，即时聊天等功能。安装方式：

// 使用 npmnpm i @tencentcloud/tuiroom-engine-electron --save
// 使用 pnpmpnpm i @tencentcloud/tuiroom-engine-electron --save
// 使用 yarnyarn add @tencentcloud/tuiroom-engine-electron

TUIRoomEngine API

TUIRoomEngine 静态方法

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

roomEngine 房间管理 API

API	描述
createRoom	创建房间
enterRoom	进入房间
destroyRoom	销毁房间
exitRoom	离开房间
fetchRoomInfo	获取房间信息
updateRoomNameByAdmin	更新房间的名字（仅群主或者管理员可以调用）
updateRoomSpeechModeByAdmin	更新房间的发言模式（仅群主或者管理员可以调用）
getUserList	获取当前房间用户列表
getUserInfo	获取用户的详细信息

roomEngine 音视频 API

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

roomEngine 成员管理 API

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

roomEngine 屏幕分享 API

API	描述
startScreenSharingElectron	开始屏幕共享
stopScreenSharingElectron	停止屏幕共享
getScreenSharingTarget	获取屏幕分享列表
selectScreenSharingTarget	切换屏幕分享窗口

roomEngine 麦位管理API

API	描述
setMaxSeatCount	设置房间麦位最大值
getSeatList	获取麦位信息
takeSeat	获取麦位
leaveSeat	释放麦位
takeUserOnSeatByAdmin	邀请其他人上麦（仅房间主持人和管理员可调用此方法）
kickUserOffSeatByAdmin	将其他人踢下麦（仅房间主持人和管理员可调用此方法）
lockSeatByAdmin	锁定某个麦位状态（仅房间主持人和管理员可调用此方法）

roomEngine 消息发送API

API	描述
sendTextMessage	发送文本消息
sendCustomMessage	发送自定义消息

roomEngine 设备管理 API

API	描述
getCameraDevicesList	获取摄像头设备列表
getMicDevicesList	获取麦克风设备列表
getSpeakerDevicesList	获取扬声器设备列表
setCurrentCameraDevice	设置要使用的摄像头设备
setCurrentMicDevice	设置要使用的麦克风设备
setCurrentSpeakerDevice	设置要使用的扬声器设备
getCurrentCameraDevice	获取当前正在使用的摄像头设备
getCurrentMicDevice	获取当前正在使用的麦克风设备
getCurrentSpeakerDevice	获取当前正在使用的扬声器设备
startCameraDeviceTest	开始进行摄像头测试
stopCameraDeviceTest	停止摄像头测试

roomEngine 事件监听 API

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

roomEngine 其他 API

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

API 详情

once

监听 TUIRoomEngine ‘ready’ 事件

TUIRoomEngine.once('ready', () => {  const roomEngine = new TUIRoomEngine();    await TUIRoomEngine.init({    sdkAppId: 0,   // 填写您申请的 sdkAppId    userId: '',    // 填写您业务对应的 userId    userSig: '',   // 填写服务器或本地计算的 userSig  });    await roomEngine.createRoom({    roomId: '12345',   // 填入您的房间 Id, 注意房间 Id 要求为字符串类型    name: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节    roomType: TUIRoomType.kGroup, // 设置房间类型为 TUIRoomType.kGroup 类型  });});

login

说明：v1.0.0 版本该接口命名为 TUIRoomEngine.init 接口，v1.0.1 及其以上版本请使用 TUIRoomEngine.login 登录 TUIRoomEngine。登录 TUIRoomEngine， 您必须在登录 TUIRoomEngine 之后才可以调用 TUIRoomEngine 及其实例的其他方法。

// 登录 TUIRoomEngineawait TUIRoomEngine.login({ sdkAppId: 0,   // 填写您申请的 sdkAppId userId: '',    // 填写您业务对应的 userId userSig: '',   // 填写服务器或本地计算的 userSig});

参数：

参数	类型	说明	默认值	含义
sdkAppId	number	必填	–	sdkAppId在 实时音视频控制台 单击 应用管理 > 创建应用 创建新应用之后，即可在 应用信息 中获取 sdkAppId 信息。
userId	string	必填	–	用户ID建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
userSig	string	必填	–	userSig 签名计算 userSig 的方式请参考 UserSig 相关。
tim	TIM	非必填	–	若您在接入 roomEngine 的同时想使用即时通信 SDK 的更多能力，您可以将创建的 tim 实例传入 TUIRoomEngine。tim 实例的创建方式请参考 TIM.create。

Returns Promise

setSelfInfo

设置当前用户基本信息（用户名、用户头像）。

// 设置当前用户用户名及用户头像await TUIRoomEngine.setSelfInfo({ userName: '',     // 填写您的新用户名 avatarUrl: '',    // 填写您的新头像地址});

参数：

参数	类型	说明	默认值	含义
userName	string	必填	–	用户名
avatarUrl	string	必填	–	用户头像

Returns Promise

getSelfInfo

获取当前用户基本信息（用户名、用户头像）。

// 获取当前用户用户名及用户头像const loginUserInfo = await TUIRoomEngine.getSelfInfo();

Returns Promise<TUILoginUserInfo> loginUserInfo

logout

说明：该接口自 v1.0.1 版本支持。登出 TUIRoomEngine。

// 登出 TUIRoomEngineawait TUIRoomEngine.logout();

Returns Promise

createRoom

主持人创建房间，调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 ID，房间名称，房间类型，发言模式，是否允许加入用户开启音视频，发送消息等功能。

const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({    roomId: '12345',   // 填入您的房间 Id, 注意房间 Id 要求为字符串类型    roomName: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节    roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型    speechMode: TUISpeechMode.kFreeToSpeak, // 设置发言模式为自由发言模式    isMicrophoneDisableForAllUser: false,  // 设置是否允许加入用户打开麦克风    isCameraDisableForAllUser: false,  // 设置是否允许加入用户打开摄像头    isMessageDisableForAllUser: false,  // 设置是否允许加入用户发送消息});

参数：

参数	类型	说明	默认值	含义
roomId	string	必填	–	房间 ID，roomId 限制长度为64字节，且仅支持以下范围的字符集：大小写英文字母（a-zA-Z）数字（0-9）空格 ! # $ % & ( ) + – : ; ? @ [ ] ^ _ { } | ~ ,
roomName	string	选填	roomId	房间名称，默认值为 roomId，不可传入空字符串
roomType	TUIRoomType	选填	TUIRoomType.kConference	房间类型办公协同、医疗问诊、远程会议、教育场景，roomType 设置为 TUIRoomType.kConference电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLivingRoom
speechMode	TUISpeechMode	选填	TUISpeechMode.kFreeToSpeak	房间内发言模式roomType 为 TUIRoomType.kConference (教育及会议场景)speechMode 设置为 TUISpeechMode.kFreeToSpeak，用户进房默认可以打开摄像头和麦克风 speechMode 设置为 TUISpeechMode.kApplyToSpeak，用户进房默认不打开摄像头和麦克风，需要向主持人申请打开摄像头或麦克风TUISpeechMode.kFreeToSpeak 及 TUISpeechMode.kApplyToSpeak 模式可互相切换 speechMode 设置为 TUISpeechMode.kSpeakAfterTakingSeat，用户进房后需要调用 takeSeat 上麦接口获取打开摄像头和麦克风的权限 roomType 为 TUIRoomType.kLivingRoom (直播场景) 时：speechMode 设置为 TUISpeechMode.kFreeToSpeak，上麦不需要主持人同意speechMode 设置为 TUISpeechMode.kSpeakAfterTakingSeat，上麦需要主持人同意TUISpeechMode.kFreeToSpeak 及 TUISpeechMode.kSpeakAfterTakingSeat 模式可互相切换
isMicrophoneDisableForAllUser	boolean	选填	false	是否开启全员禁麦，默认不开启全员禁麦
isCameraDisableForAllUser	boolean	选填	false	是否开启全员禁画，默认不开启全员禁画
isMessageDisableForAllUser	boolean	选填	false	是否允许成员发送消息，默认不禁止
maxSeatCount	number	选填	–	最大麦位数量roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16
enableCDNStreaming	boolean	选填	false	是否开启 CDN 直播流
cdnStreamDomain	string	选填	”	直播推流域名

Returns Promise

enterRoom

进入房间接口。

const roomEngine = new TUIRoomEngine();const roomInfo = await roomEngine.enterRoom({    roomId: '12345',});

参数：

参数	类型	说明	默认值	含义
roomId	string	必填	–	房间号

Returns Promise<TUIRoomInfo> roomInfo该接口返回当前房间信息

destroyRoom

解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入。

const roomEngine = new TUIRoomEngine();await roomEngine.destroyRoom();

Returns Promise

exitRoom

离开房间接口，用户在执行 enterRoom 之后可通过 exitRoom 离开房间。

const roomEngine = new TUIRoomEngine();await roomEngine.exitRoom();

Returns Promise

fetchRoomInfo

获取房间信息。

const roomEngine = new TUIRoomEngine();const roomInfo = roomEngine.fetchRoomInfo();

Returns：Promise<TUIRoomInfo> roomInfo

updateRoomNameByAdmin

更新当前房间的名字（仅群主或者管理员可以调用）。

const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({ roomId: '12345' });await roomEngine.updateRoomNameByAdmin({ roomName: '新的名字' });

参数：

参数	类型	说明	默认值	含义
roomName	string	必填	–	更新房间的名字，要求 roomName 不为空字符串

Returns Promise

updateRoomSpeechModeByAdmin

更新房间的发言模式（仅群主或者管理员可以调用）。

const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({ roomId: '12345' });await roomEngine.updateRoomSpeechModeByAdmin({  speechMode: TUISpeechMode.kSpeakAfterTakingSeat  // 更新为上麦后发言模式});

参数：

参数	类型	说明	默认值	含义
speechMode	TUISpeechMode	必填	–	更新房间的发言模式

getUserList

获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 100 个。

const roomEngine = new TUIRoomEngine();const userList = [];let result;do {  result = await globalProperties.roomEngine.getUserList();  userList.push(...result.userInfoList);} while (result.nextSequence !== 0)

参数：

参数	类型	说明	默认值	含义
nextSequence	number	选填	0	偏移量，默认从 0 开始拉取用户

Returns：Promise