TUIRoom is an open-source audio/video component that comes with a UI kit. It allows you to quickly implement features including audio/video room, screen sharing, and chat messages into your project.
Note:
All components of TUIKit use two basic PaaS services of Tencent Cloud, namely TRTC and Chat. When you activate TRTC, Chat and the trial edition of the Chat SDK (which supports up to 100 DAUs) will be activated automatically. For the billing details of Chat, see Pricing.
You can download the macOS or Windows edition of our TUIRoom Electron demo to try out more features.
You can also download the code for TUIRoom and refer to this document to quickly implement a TUIRoom demo project.
This document shows you how to integrate the TUIRoom Electron component into your existing project.
Integration
The TUIRoom component is developed using Vue 3 + TypeScript + Pinia + Element Plus + SCSS, so your project must be based on Electron + Vue 3 + TypeScript.
In the TRTC console, click Application Management on the left sidebar and then click Create Application.
2. Get the SDKAppID and key
2.1 On the Application Management page, find the application you created, and click Application Info to view its SDKAppID (different applications cannot communicate with each other).
2.2 Select the Quick Start tab to view the application's secret key. Each SDKAppID corresponds to a secret key. They are used to generate the signature (UserSig) required to legitimately use TRTC services.
2.3 Generate UserSigUserSig is a security signature designed by Tencent Cloud to prevent attackers from accessing your Tencent Cloud account. It is required when you initialize the TUIRoom component.
1. Open an existing Electron + Vue3 + TypeScript project. If you don’t have one, you can use this sample to create a project.
Note:
The steps in this document are based on electron-vite-vue 1.0.0.
We have updated the directory structure of electron-vite-vue. If you use the latest version, some of the paths and configuration described in this document may not apply.
2. After the template project is successfully generated, run the following script:
cd electron-vite-vue
npminstall
npm run dev
3. Clone or download the TUIRoom code, and copy the TUIRoom/Electron/packages/renderer/src/TUIRoom folder to packages/renderer/src/ of your project.
Step 3. Import the TUIRoom component
Import the TUIRoom component into your webpage, such as App.vue.
The TUIRoom component classifies users as hosts and participants and offers APIs including init, createRoom, and enterRoom.
Hosts and participants can call init to initialize application and user data. Hosts can call createRoom to create and enter rooms. Participants can call enterRoom to join the rooms created by hosts.
<template>
<room ref="TUIRoomRef"></room>
</template>
<script setup lang="ts">
import{ ref, onMounted }from'vue';
// Import the TUIRoom component. Be sure to use the correct import path.
import Room from'./TUIRoom/index.vue';
// Get the TUIRoom component elements used to call the component’s APIs
const TUIRoomRef =ref();
onMounted(async()=>{
// Initialize the TUIRoom component
// A host needs to initialize the TUIRoom component before creating a room
// A participant needs to initialize the TUIRoom component before entering a room
await TUIRoomRef.value.init({
// Get the `SDKAppID` (see step 1)
sdkAppId:0,
// The user's unique ID in your business
userId:'',
// For local development and debugging, you can quickly generate a `UserSig` at https://console.tencentcloud.com/trtc/usersigtool. Each `UserID` corresponds to a `UserSig`.
userSig:'',
// The user's username in your business
userName:'',
// The URL of the user's profile photo in your business
userAvatar:'',
// The user's unique ID used for screen sharing. It must be in the format of `share_${userId}`. You don’t need to pass this parameter if you don’t need the screen sharing feature.
shareUserId:'',
// Refer to steps 1-3 above and use the `SDKAppID` and `shareUserId` to generate `shareUserSig`
shareUserSig:'',
})
// By default, a room is created at this point. During actual implementation, you can specify when to call `handleCreateRoom()`.
awaithandleCreateRoom();
})
// The host creates a room. Call this API only when you need to create a room.
asyncfunctionhandleCreateRoom(){
// `roomId` is the ID of the room to enter, which must be a number.
// The valid values of `roomMode` are `FreeSpeech` (free speech mode) and `ApplySpeech` (request-to-speak mode). The default value is `FreeSpeech`, which is the only supported mode currently.
// `roomParam` specifies whether to turn on the mic/camera upon room entry, as well as the default media device ID to use
TUIRoom uses Pinia for room data management. You need to register Pinia in the project entry file packages/renderer/src/main.ts.
// `src/main.ts` file
import{ createPinia }from'pinia';
const app =createApp(App);
// Register Pinia
createApp(App)
.use(createPinia())
.mount('#app')
.$nextTick(window.removeLoading)
3. Import Element Plus components
TUIRoom uses Element Plus UI components, which you need to import in packages/renderer/vite.config.ts. You can manually import only the components you need.
Note:
Add the code below in the file. Do not delete the existing configuration.
@use '${path.resolve(__dirname, 'src/TUIRoom/assets/style/element.scss')}' as *;
`,
},
},
},
});
Meanwhile, in order to ensure that Element Plus UI components can display styles properly, you need to load Element Plus component styles in the entry file `packages/renderer/src/main.ts`.
4. Import trtc-electron-sdk
In order to import trtc-electron-sdk using the import statement at the UI layer, you need to configure packages/renderer/vite.config.ts as follows (otherwise, you will have to use the require statement):
Note:
Replace the configuration in resolve with the following:
Configure the env.d.ts file in packages/renderer/src/env.d.ts as follows:
Note:
Add the code below in env.d.ts. Do not delete the existing configuration in the file.
// env.d.ts
declare module 'tsignaling/tsignaling-js'{
import TSignaling from'tsignaling/tsignaling-js';
exportdefault TSignaling;
}
declare module 'tim-js-sdk'{
importTIMfrom'tim-js-sdk';
exportdefaultTIM;
}
6. If there are dynamic imports in your project, you need to modify the build configuration to generate an ES module.
Modify the configuration in packages/renderer/vite.config.ts as follows.
Note:
Add the code below in the file. Do not delete the existing Vite configuration. Skip this step if your project does not have dynamic imports.
// vite.config.ts
exportdefaultdefineConfig({
// ...
build:{
rollupOptions:{
output:{
format:'es'
}
}
},
});
Step 5. Run your project in the development environment
In the console, execute the development environment script. Then, open the page integrated with the TUIRoom component with a browser.
If you used the script in step 2 to generate an Electron + Vue3 + TypeScript project, follow the steps below:
1. Run the development environment command.
npm run dev
Note:
Because Element Plus components are imported manually, it may take a relatively long time for the page to load in the development environment for the first time. This will not be an issue after building.
2. Try out the features of the TUIRoom component.
Step 6. Create an installer and run it
Run the following command in a terminal window to generate an installer in the release directory.
npm run build
Note:
You need macOS to create a macOS installer and Windows to create a Windows installer.
Appendix: TUIRoom APIs
TUIRoom APIs
init
This API is used to initialize TUIRoom data. Anyone using TUIRoom needs to call this API.
TUIRoomRef.value.init(roomData);
The parameters are described below:
Parameter
Type
Description
roomData
object
roomData.sdkAppId
number
The SDKAppID.
roomData.userId
string
The unique user ID.
roomData.userSig
string
The UserSig.
roomData.userName
string
The username.
roomData.userAvatar
string
The user’s profile photo.
roomData.shareUserId
string
The UserID used for screen sharing, which must be in the format of share_${userId}. You don’t need to pass this parameter if you don’t need the screen sharing feature.
roomData.shareUserSig
string
The UserSig used for screen sharing, which is optional.
The speech mode, including FreeSpeech (free speech) and ApplySpeech (request-to-speak). The default value is FreeSpeech, which is the only supported mode currently.
roomParam
Object
Optional
roomParam.isOpenCamera
string
Whether to turn on the camera upon room entry. This parameter is optional and the default is no.
roomParam.isOpenMicrophone
string
Whether to turn on the mic upon room entry. This parameter is optional and the default is no.
roomParam.defaultCameraId
string
The ID of the default camera, which is optional.
roomParam.defaultMicrophoneId
string
The ID of the default mic, which is optional.
roomParam.defaultSpeakerId
String
The ID of the default speaker, which is optional.
enterRoom
This API is used by a participant to enter a room.
TUIRoomRef.value.enterRoom(roomId, roomParam);
The parameters are described below:
Parameter
Type
Description
roomId
number
The room ID.
roomParam
Object
Optional
roomParam.isOpenCamera
string
Whether to turn on the camera upon room entry. This parameter is optional and the default is no.
roomParam.isOpenMicrophone
string
Whether to turn on the mic upon room entry. This parameter is optional and the default is no.