// 使用 npmnpm i @tencentcloud/tuiroom-engine-electron@2.4.0-alpha.3 --save// 使用 pnpmpnpm i @tencentcloud/tuiroom-engine-electron@2.4.0-alpha.3 --save// 使用 yarnyarn add @tencentcloud/tuiroom-engine-electron@2.4.0-alpha.3
API | 描述 |
监听 TUIRoomEngine ready 事件。 注意: TUIRoomEngine.login 以外的所有方法必须在监听到 TUIRoomEngine ready 事件且 TUIRoomEngine.login 方法执行成功后执行。 | |
登录 TUIRoomEngine | |
登出 TUIRoomEngine | |
设置当前用户基本信息(用户名、用户头像) | |
获取当前用户基本信息(用户名、用户头像) | |
获取设备管理器 | |
获取音效管理器 | |
获取媒体源混流管理器 | |
获取视频特效插件管理器 |
API | 描述 |
创建房间 | |
进入房间 | |
销毁房间 | |
离开房间 | |
获取房间信息 | |
更新房间的名字(仅群主或者管理员可以调用) | |
更新房间上麦模式(仅群主或者管理员可以调用) | |
获取当前房间用户列表 | |
获取用户的详细信息 |
API | 描述 |
设置本地流的渲染位置 | |
本地摄像头视频流采集 | |
关闭本地摄像头 | |
打开本地麦克风 | |
关闭本地麦克风 | |
设置本地视频的参数 | |
设置本地视频流的分辨率模式 | |
设置本地视频的编码参数 | |
设置本地音频的参数 | |
开始向远端推本地视频流 | |
停止向远端推本地视频流 | |
停止向远端推本地音频流 | |
开始向远端推本地音频流 | |
设置远端流渲染的区域 | |
开始播放远端用户视频流 | |
停止播放远端用户视频流 | |
停止远端用户的音频流 |
API | 描述 |
取消已经发出的请求 | |
回复远端用户的请求 | |
改变用户的角色 | |
将用户踢出房间 | |
禁止/允许某个用户发送消息 |
API | 描述 |
获取麦位信息 | |
获取麦位 | |
释放麦位 | |
邀请其他人上麦(仅房间主持人和管理员可调用此方法) | |
将其他人踢下麦(仅房间主持人和管理员可调用此方法) | |
锁定某个麦位状态(仅房间主持人和管理员可调用此方法) | |
获取上麦请求列表(仅房间主持人和管理员可调用此方法) |
API | 描述 |
开始屏幕共享 | |
停止屏幕共享 | |
获取屏幕分享列表 | |
切换屏幕分享窗口 |
API | 描述 |
API | 描述 |
获取 trtcCloud 实例 | |
获取 tim 实例 |
TUIRoomEngine.once('ready', () => {const roomEngine = new TUIRoomEngine();await TUIRoomEngine.init({sdkAppId: 0, // 填写您申请的 sdkAppIduserId: '', // 填写您业务对应的 userIduserSig: '', // 填写服务器或本地计算的 userSig});await roomEngine.createRoom({roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型name: 'Test Room', // 填入您的房间名称, 房间名称默认为 roomId,最长 30 字节roomType: TUIRoomType.kLive, // 设置房间类型为 TUIRoomType.kLive 类型});});
// 登录 TUIRoomEngineawait TUIRoomEngine.login({sdkAppId: 0, // 填写您申请的 sdkAppIduserId: '', // 填写您业务对应的 userIduserSig: '', // 填写服务器或本地计算的 userSig});
参数 | 类型 | 说明 | 默认值 | 含义 |
sdkAppId | number | 必填 | - | sdkAppId |
userId | string | 必填 | - | 用户ID建议限制长度为32字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。 |
userSig | string | 必填 | - | userSig 签名 |
tim | TIM | 非必填 | - |
// 登出 TUIRoomEngineawait TUIRoomEngine.logout();
// 设置当前用户用户名及用户头像await TUIRoomEngine.setSelfInfo({userName: '', // 填写您的新用户名avatarUrl: '', // 填写您的新头像地址});
参数 | 类型 | 说明 | 默认值 | 含义 |
userName | string | 必填 | - | 用户名 |
avatarUrl | string | 必填 | - | 用户头像 |
// 获取当前用户用户名及用户头像const loginUserInfo = await TUIRoomEngine.getSelfInfo();
import TUIRoomEngine, {TUIDeviceManager} from '@tencentcloud/tuiroom-engine-electron';const deviceManager:TUIDeviceManager = TUIRoomEngine.getDeviceManager();
import TUIRoomEngine, {TUIAudioEffectManager} from '@tencentcloud/tuiroom-engine-electron';const audioEffectManager: TUIAudioEffectManager = TUIRoomEngine.getAudioEffectManager();
import TUIRoomEngine, { TUIMediaMixingManager } from '@tencentcloud/tuiroom-engine-electron';const mediaMixingManager: TUIMediaMixingManager = TUIRoomEngine.getMediaMixingManager();
import TUIRoomEngine, {TUIVideoEffectPluginManager} from '@tencentcloud/tuiroom-engine-electron';const videoEffectPluginManager: TUIVideoEffectPluginManager = TUIRoomEngine.getVideoEffectPluginManager();
const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型roomName: 'Test Room', // 填入您的房间名称, 房间名称默认为 roomId,最长 30 字节roomType: TUIRoomType.kLive, // 设置房间类型为 TUIRoomType.kLive 类型isSeatEnabled: false, // 设置是否开启麦位控制isMicrophoneDisableForAllUser: false, // 设置是否允许加入用户打开麦克风isCameraDisableForAllUser: false, // 设置是否允许加入用户打开摄像头isMessageDisableForAllUser: false, // 设置是否允许加入用户发送消息});
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 房间 ID,roomId 限制长度为64字节,且仅支持以下范围的字符集: 大小写英文字母(a-zA-Z) 数字(0-9) 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ , |
roomName | string | 选填 | roomId | 房间名称,默认值为 roomId,不可传入空字符串 |
roomType | 选填 | TUIRoomType.kConference | 房间类型 办公协同、医疗问诊、远程会议、教育场景,roomType 设置为 TUIRoomType.kConference 电商直播、语聊房场景,roomType 设置为 TUIRoomType.kLive | |
isSeatEnabled | boolean | 选填 | false | 是否开启麦位控制,默认不开启 |
seatMode | 选填 | TUISeatMode.kFreeToTake | 上麦模式(开启麦位控制后生效),默认值为 TUISeatMode.kFreeToTake
自由上麦模式,台下观众可以自由上麦,无需申请,seatMode 设置为 TUISeatMode.kFreeToTake
申请上麦模式,台下观众上麦需要房主或者管理员同意后才能上麦,seatMode 设置为 TUISeatMode.kApplyToTake | |
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 | 选填 | '' | 直播推流域名 |
const roomEngine = new TUIRoomEngine();const roomInfo = await roomEngine.enterRoom({roomId: '12345',roomType: TUIRoomType.kLive});
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 房间号 |
roomType | 选填 | TUIRoomType.kConference | 房间类型(自 v2.3.0 支持) |
const roomEngine = new TUIRoomEngine();await roomEngine.destroyRoom();
const roomEngine = new TUIRoomEngine();await roomEngine.exitRoom();
const roomEngine = new TUIRoomEngine();const roomInfo = roomEngine.fetchRoomInfo();
const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({ roomId: '12345' });await roomEngine.updateRoomNameByAdmin({ roomName: '新的名字' });
参数 | 类型 | 说明 | 默认值 | 含义 |
roomName | string | 必填 | - | 更新房间的名字,要求 roomName 不为空字符串 |
const roomEngine = new TUIRoomEngine();await roomEngine.createRoom({ roomId: '12345' });await roomEngine.updateRoomSeatModeByAdmin({seatMode: TUISeatMode.kApplyToTake, // 更新为申请上麦模式});
参数 | 类型 | 说明 | 默认值 | 含义 |
seatMode | 必填 | - | 发言类型 |
const roomEngine = new TUIRoomEngine();const userList = [];let result;let nextSequence = 0;do {result = await roomEngine.getUserList({ nextSequence });userList.push(...result.userInfoList);nextSequence = result.nextSequence;} while (result.nextSequence !== 0)
参数 | 类型 | 说明 | 默认值 | 含义 |
nextSequence | number | 选填 | 0 | 偏移量,默认从 0 开始拉取用户 |
const roomEngine = new TUIRoomEngine();const userList = [];const userInfo = await roomEngine.getUserInfo({userId: 'user_12345',});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 根据 userId 获取该用户的详细信息 |
const roomEngine = new TUIRoomEngine();// 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素await roomEngine.setLocalVideoView({view: 'preview-camera',});
参数 | 类型 | 说明 | 默认值 | 含义 |
view | string | 必填 | - | streamType 对应的流渲染的 div 元素的 id |
const roomEngine = new TUIRoomEngine();await roomEngine.setLocalVideoView({streamType: TUIVideoStreamType.kCameraStream,view: 'preview-camera',});await roomEngine.openLocalCamera();
const roomEngine = new TUIRoomEngine();await roomEngine.closeLocalCamera();
const roomEngine = new TUIRoomEngine();await roomEngine.openLocalMicrophone();
const roomEngine = new TUIRoomEngine();await roomEngine.closeLocalMicrophone();
const roomEngine = new TUIRoomEngine();await roomEngine.updateVideoQuality({quality: TUIVideoQuality.kVideoQuality_540p,});
参数 | 类型 | 说明 | 默认值 | 含义 |
quality | 必填 | - | 清晰 TUIVideoProfile.kVideoQuality_360P 标清 TUIVideoProfile.kVideoQuality_540P 高清 TUIVideoProfile.kVideoQuality_720P 超清 TUIVideoProfile.kVideoQuality_1080P |
const roomEngine = new TUIRoomEngine();await roomEngine.setVideoResolutionMode({type: TUIVideoStreamType.kCameraStream,resolutionMode: TUIResolutionMode.kResolutionMode_Landscape,});
参数 | 类型 | 说明 | 默认值 | 含义 |
streamType | 必填 | - | 本地流类型 | |
resolutionMode | 必填 | TUIResolutionMode.kResolutionMode_Landscape | 分辨率模式 |
const roomEngine = new TUIRoomEngine();await roomEngine.updateVideoQualityEx({streamType: TUIVideoStreamType.kCameraStream,encoderParams: {videoResolution: TUIVideoQuality.kVideoQuality_720p,fps: 15,bitrate: 2000,resolutionMode: TUIResolutionMode.kResolutionMode_Landscape,}});
参数 | 类型 | 说明 | 默认值 | 含义 |
streamType | 必填 | - | 本地流类型 | |
encoderParams | 必填 | - | 详细编码参数 |
const roomEngine = new TUIRoomEngine();await roomEngine.updateAudioQuality({quality: TUIAudioQuality.kAudioProfileMusic,});
参数 | 类型 | 说明 | 默认值 | 含义 |
audioProfile | 必填 | - | TUIAudioQuality.kAudioProfileSpeech:语言模式;采样率:16k TUIAudioQuality.kAudioProfileDefault:标准模式(或者默认模式);采样率:48k TUIAudioQuality.kAudioProfileMusic:音乐模式;采样率:48k |
const roomEngine = new TUIRoomEngine();await roomEngine.startPushLocalVideo();
const roomEngine = new TUIRoomEngine();await roomEngine.stopPushLocalVideo();
const roomEngine = new TUIRoomEngine();await roomEngine.muteLocalAudio();
const roomEngine = new TUIRoomEngine();await roomEngine.unmuteLocalAudio();
const roomEngine = new TUIRoomEngine();// 设置远端用户视频流在 id 为 'remote_preview_camera' 的区域播放await roomEngine.setRemoteVideoView({userId: 'user_1234',streamType: TUIVideoStreamType.kCameraStream,view: 'remote_preview_camera',});// 设置远端用户屏幕分享流在 id 为 'remote_preview_screen' 的区域播放await roomEngine.setRemoteVideoView({userId: 'user_1234',streamType: TUIVideoStreamType.kScreenStream,view: 'remote_preview_screen',});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
streamType | 必填 | - | 用户流类型 | |
view | string | 必填 | - | 播放远端用户流的 div 元素的 id |
const roomEngine = new TUIRoomEngine();await roomEngine.startPlayRemoteVideo({userId: 'user_1234',streamType: TUIVideoStreamType.kCameraStream,});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
streamType | 必填 | - | 用户流类型 TUIVideoStreamType.kCameraStream 视频流 TUIVideoStreamType.kScreenStream 屏幕分享流 TUIVideoStreamType.kCameraStreamLow 低清视频流 |
const roomEngine = new TUIRoomEngine();await roomEngine.stopPlayRemoteVideo({userId: 'user_1234',streamType: TUIVideoStreamType.kCameraStream,});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
streamType | 必填 | - | 用户流类型 TUIVideoStreamType.kCameraStream 视频流 TUIVideoStreamType.kScreenStream 屏幕分享流 TUIVideoStreamType.kCameraStreamLow 低清视频流 |
const roomEngine = new TUIRoomEngine();await roomEngine.muteRemoteAudioStream({userId: 'user_1234',isMute: true,});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
isMute | boolean | 必填 | - | 是否停止远端用户的音频 |
const roomEngine = new TUIRoomEngine();await roomEngine.cancelRequest({requestId: '', // 请使用实际 requestId});
参数 | 类型 | 说明 | 默认值 | 含义 |
requestId | string | 必填 | - | 请求 ID |
const roomEngine = new TUIRoomEngine();// 同意远端的请求await roomEngine.responseRemoteRequest({requestId: '', // 请使用实际 requestIdagree: true,});// 拒绝远端的请求await roomEngine.responseRemoteRequest({requestId: '', // 请使用实际 requestIdagree: false,});
参数 | 类型 | 说明 | 默认值 | 含义 |
requestId | string | 必填 | - | 请求 ID |
agree | boolean | 必填 | - | 是否同意 |
await roomEngine.disableSendingMessageByAdmin({userId: 'user_1234',isDisable: true,});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
isDisable | boolean | 必填 | - | 是否被禁用 |
const roomEngine = new TUIRoomEngine();// 将房间移交给用户 user_1234await roomEngine.changeUserRole({userId: 'user_1234',role: TUIRole.kRoomOwner,});// 将用户 user_1234 设置为房间管理员await roomEngine.changeUserRole({userId: 'user_1234',userRole: TUIRole.kAdministrator,});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
userRole | 必填 | - | 用户角色 主持人 TUIRole.kRoomOwner 管理员 TUIRole.kAdministrator 普通成员 TUIRole.kGeneralUser |
const roomEngine = new TUIRoomEngine();await roomEngine.kickRemoteUserOutOfRoom({userId: 'user_1234',});
参数 | 类型 | 说明 | 默认值 | 含义 |
userId | string | 必填 | - | 用户 ID |
const roomEngine = new TUIRoomEngine();const seatList = await roomEngine.getSeatList();
const roomEngine = new TUIRoomEngine();// 情景一:主持人/管理员上麦// 情景二:当 roomInfo.roomType 为 TUIRoomType.kConference// 且 roomInfo.seatMode 为 TUISeatMode.kFreeToTake 模式时,普通用户上麦await roomEngine.takeSeat({seatIndex: -1,timeout: 0,});// 情景三:当 roomInfo.seatMode 为 TUISeatMode.kApplyToTake 模式时,普通用户上麦const requestId = await roomEngine.instance?.takeSeat({seatIndex: -1,timeout: 0,requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {switch (requestCallbackType) {case TUIRequestCallbackType.kRequestAccepted:// 请求被接受break;case TUIRequestCallbackType.kRequestRejected:// 请求被拒绝break;case TUIRequestCallbackType.kRequestCancelled:// 请求已取消break;case TUIRequestCallbackType.kRequestTimeout:// 请求超时break;case TUIRequestCallbackType.kRequestError:// 请求错误break;default:break;}},});
参数 | 类型 | 说明 | 默认值 | 含义 |
seatIndex | number | 必填 | - | 麦位 index, 无麦位序号时设置为 -1 |
timeout | number | 必填 | - | 超时时间。若 timeout 设置为 0,则无超时时间 |
requestCallback | Function | 选填 | 空函数 | 请求回调,用来通知发起方请求被接受/拒绝/取消/超时/错误的回调 |
const roomEngine = new TUIRoomEngine();await roomEngine.leaveSeat();
const roomEngine = new TUIRoomEngine();const requestId = roomEngine.takeUserOnSeatByAdmin({seatIndex: 0,userId: 'user_1234',timeout: 0,requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {switch (requestCallbackType) {case TUIRequestCallbackType.kRequestAccepted:// 请求被接受break;case TUIRequestCallbackType.kRequestRejected:// 请求被拒绝break;case TUIRequestCallbackType.kRequestCancelled:// 请求已取消break;case TUIRequestCallbackType.kRequestTimeout:// 请求超时break;case TUIRequestCallbackType.kRequestError:// 请求错误break;default:break;}},});
参数 | 类型 | 说明 | 默认值 | 含义 |
seatIndex | number | 必填 | - | 麦位 index |
userId | string | 必填 | - | 用户 ID |
timeout | number | 必填 | - | 超时时间。若 timeout 设置为 0 ,则无超时时间 |
requestCallback | Function | 选填 | 空函数 | 请求回调,用来通知发起方请求被接受/拒绝/取消/超时/错误的回调 |
const roomEngine = new TUIRoomEngine();const requestId = await roomEngine.kickUserOffSeatByAdmin({seatIndex: 0,userId: 'user_1234',});
参数 | 类型 | 说明 | 默认值 | 含义 |
seatIndex | number | 必填 | - | 麦位 index |
userId | string | 必填 | - | 用户 ID |
const roomEngine = new TUIRoomEngine();await roomEngine.lockSeatByAdmin({seatIndex: 0,lockParams: {lockSeat: true,lockVideo: true,lockAudio: true,},});
参数 | 类型 | 说明 | 默认值 | 含义 |
seatIndex | number | 必填 | - | 麦位索引 |
lockParams | 必填 | - | 锁麦参数 |
const roomEngine = new TUIRoomEngine();const applicationList = await roomEngine.getSeatApplicationList();
const roomEngine = new TUIRoomEngine();// 情景一:开始屏幕共享await roomEngine.startScreenSharingElectron({targetId: 'targetId'});// 情景二:开始屏幕共享并在本地预览await roomEngine.startScreenSharingElectron({targetId: 'targetId',view: 'screen-preview'});
参数 | 类型 | 说明 | 默认值 | 含义 |
targetId | string | 选填 | - | 分享窗口 ID,可从 getScreenSharingTarget 获取 |
view | string | 选填 | - | 本地预览屏幕分享的 dom 元素的 id |
const roomEngine = new TUIRoomEngine();await roomEngine.stopScreenSharingElectron();
const roomEngine = new TUIRoomEngine();const screenList = await roomEngine.getScreenSharingTarget();
const roomEngine = new TUIRoomEngine();await roomEngine.selectScreenSharingTarget({targetId: 'targetId'});
参数 | 类型 | 说明 | 默认值 | 含义 |
targetId | string | 必填 | - | 分享窗口 ID,可从 getScreenSharingTarget 获取 |
const roomEngine = new TUIRoomEngine();roomEngine.on(event, func);
参数 | 类型 | 说明 | 默认值 | 含义 |
event | 必填 | - | TUIRoomEngine 事件列表 | |
func | Function | 必填 | - | 事件回调函数 |
const roomEngine = new TUIRoomEngine();roomEngine.off(event, func);
参数 | 类型 | 说明 | 默认值 | 含义 |
event | 必填 | - | TUIRoomEngine 事件列表 | |
func | Function | 必填 | - | 事件回调函数 |
const roomEngine = new TUIRoomEngine();const trtcCloud = roomEngine.getTRTCCloud();
const roomEngine = new TUIRoomEngine();const tim = roomEngine.getTIM();
本页内容是否解决了您的问题?