TUIRoomEngine

// Use npm
npm i @tencentcloud/tuiroom-engine-electron --save

// Use pnpm
pnpm i @tencentcloud/tuiroom-engine-electron --save

// Use yarn
yarn add @tencentcloud/tuiroom-engine-electron

TUIRoomEngine.once('ready', () => {
  const roomEngine = new TUIRoomEngine();
  
  await TUIRoomEngine.init({
    sdkAppId: 0,   // Fill your `sdkAppId`
    userId: '',    // Fill your `userId`
    userSig: '',   // Fill your `userSig` 
  });
  
  await roomEngine.createRoom({
    roomId: '12345',   // Fill room ID of type string
    name: 'Test Room',     // Fill room name, default value is `roomId`, maximize length: 30
    roomType: TUIRoomType.kLive, // Room type should be `TUIRoomType.kLive`
  });
});

// Log in to TUIRoomEngine
await TUIRoomEngine.login({
 sdkAppId: 0,   // Fill your `sdkAppId`
 userId: '',    // Fill your `userId`
 userSig: '',   // Fill the `userSig` responded from server or generated locally.
});

// Log out of TUIRoomEngine
await TUIRoomEngine.logout();

// Set basic information of the current user (user name, user avatar)
await TUIRoomEngine.setSelfInfo({
 userName: '',     // Fill your `userName`
 avatarUrl: '',    // Fill your avatar URL
});

// Get basic information of the current user (user name, user avatar)
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',   // Fill the `roomId`of string type
    roomName: 'Test Room',     // Enter your room name. The room name defaults to roomId and can be up to 30 bytes long.
    roomType: TUIRoomType.kLive, // The room type must be `TUIRoomType.kLive` for online living
    isSeatEnabled: false, // Whether to enable microphone seat control.
    isMicrophoneDisableForAllUser: false,  // Whether to allow joining users to turn on the microphone.
    isCameraDisableForAllUser: false,  // Whether to allow joining users to turn on the camera.
    isMessageDisableForAllUser: false,  // Whether to allow joining users to send instance message.
});

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

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: 'New room name' });

const roomEngine = new TUIRoomEngine();
await roomEngine.createRoom({ roomId: '12345' });
await roomEngine.updateRoomSeatModeByAdmin({
  seatMode: TUISeatMode.kApplyToTake,  // Update room seat mode
});

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)

const roomEngine = new TUIRoomEngine();
const userList = [];
const userInfo = await roomEngine.getUserInfo({
    userId: 'user_12345',
});

const roomEngine = new TUIRoomEngine();
    
// HTML div element with id 'preview-camera' to play local camera stream
await roomEngine.setLocalVideoView({
  view: 'preview-camera',
});

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,
});

const roomEngine = new TUIRoomEngine();
await roomEngine.setVideoResolutionMode({
  type: TUIVideoStreamType.kCameraStream,
  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,
  }
});

const roomEngine = new TUIRoomEngine();
await roomEngine.updateAudioQuality({
    quality: TUIAudioQuality.kAudioProfileMusic,
});

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();

// Play remote video at HTML element with id attribute 'remote_preview_camera'
await roomEngine.setRemoteVideoView({
   userId: 'user_1234',
   streamType: TUIVideoStreamType.kCameraStream,
   view: 'remote_preview_camera',
});
// Play remote user screen sharing at HTML element with id attribute 'remote_preview_screen'
await roomEngine.setRemoteVideoView({
   userId: 'user_1234',
   streamType: TUIVideoStreamType.kScreenStream,
   view: 'remote_preview_screen',
});

const roomEngine = new TUIRoomEngine();
await roomEngine.startPlayRemoteVideo({
   userId: 'user_1234',
   streamType: TUIVideoStreamType.kCameraStream,
});

const roomEngine = new TUIRoomEngine();
await roomEngine.stopPlayRemoteVideo({
   userId: 'user_1234',
   streamType: TUIVideoStreamType.kCameraStream,
});

const roomEngine = new TUIRoomEngine();
await roomEngine.muteRemoteAudioStream({
  userId: 'user_1234',
  isMute: true,
});

const roomEngine = new TUIRoomEngine();
await roomEngine.cancelRequest({
   requestId: '',    // Request unique ID
});