This article will guide you through a quick integration of TUIRoomKit components. You will go through several key steps in less than 10 minutes and end up with a full user interface for multiplayer conferencing.
TUIRoomKit Demo Experience
You can visit our online TUIRoomKit demo to experience more features of TUIRoomKit. You can also visit Github to download the TUIRoomKit code and refer to the README.md file to run the TUIRoomKit Web sample project. Environment Preparation
Node.js version: Node.js ≥ 16.19.1 (It is recommended to use the official LTS version, and the npm version should match the node version).
Integrating TUIRoomKit Component
Note：
If you don't have a vue project, you can directly refer to the Run Sample Demo run through Github sample project. If you need to integrate it into an existing project, please follow the steps below for integration.
Step 1: Install Dependencies
npm install @tencentcloud/roomkit-web-vue3 pinia --save
npm install @tencentcloud/roomkit-web-vue2.7 pinia
Note：
TUIRoomKit package provides a pre-meeting preview component, an in-meeting component, and methods for starting meetings, joining meetings, and fine-tuning the interface. For more, see RoomKit API. If these APIs don't meet your business needs, you can refer to UIKit source code export for accessing the TUIRoomKit source code. Step 2: Project Engineering Configuration
Register Pinia: TUIRoom uses Pinia for room data management, and you need to register Pinia in the project entry file. The project entry file is src/main.ts.
import { createPinia } from 'pinia';
const app = createApp(App);
app.use(createPinia());
app.mount('#app')
import { createPinia, PiniaVuePlugin } from 'pinia';
Vue.use(PiniaVuePlugin);
const pinia = createPinia();
new Vue({
pinia,
render: h => h(App),
}).$mount('#app');
Step 3: Import the TUIRoom component
Note:
Import the ConferenceMainView component, which is by default in the permanent mode (the component is always displayed, and its display and hiding are not controlled internally. If the business end does not control it, the component will always remain displayed). <template>
<ConferenceMainView></ConferenceMainView>
</template>
<script setup>
import { ConferenceMainView } from '@tencentcloud/roomkit-web-vue3';
</script>
<template>
<ConferenceMainView></ConferenceMainView>
</template>
<script>
import { ConferenceMainView } from '@tencentcloud/roomkit-web-vue2.7';
export default {
components: {
ConferenceMainView,
},
};
</script>
Step 4: Logging into the TUIRoomKit Component
Before initiating a meeting, it is necessary to invoke the login interface for authentication. To obtain the SDKAppID, userId，userSig, refer to the service activation. import { conference } from '@tencentcloud/roomkit-web-vue3';
await conference.login({
sdkAppId: 0,
userId: '',
userSig: '',
});
|
userID | String | Unique identifier of the user, defined by you, it is allowed to contain only upper and lower case letters (a-z, A-Z), numbers (0-9), underscores, and hyphens. |
SDKAppID | Number | |
SDKSecretKey | String | |
userSig | String | A security protection signature used for user log in authentication to confirm the user's identity and prevent malicious attackers from stealing your cloud service usage rights. |
Explanation of userSig:
Development environment: If you are running a demo locally and developing debugging, you can use the genTestUserSig (Refer to Step 3.2) function in the debug file to generate a `userSig`. In this method, SDKSecretKey is vulnerable to decompilation and reverse engineering. Once your key is leaked, attackers can steal your Tencent Cloud traffic.
Step 5: Initiate a new meeting
The conference host can initiate a new conference by calling the start interface. Other participants can refer to the description in step 6 and call the join interface to join the conference.
import { conference } from '@tencentcloud/roomkit-web-vue3';
const startConference = async () => {
await conference.login({
sdkAppId: 0,
userId: '',
userSig: '',
});
await conference.start('123456', {
roomName: 'TestRoom',
isSeatEnabled: false,
isOpenCamera: false,
isOpenMicrophone: false,
});
}
startConference()
Step 6: Enter an existing meeting
Participants can join the conference initiated by the conference host in step 5 by calling the join interface and filling in the corresponding roomId parameter.
import { conference } from '@tencentcloud/roomkit-web-vue3';
const joinConference = async () => {
await conference.login({
sdkAppId: 0,
userId: '',
userSig: '',
});
await conference.join('123456', {
isOpenCamera: false,
isOpenMicrophone: false,
});
}
joinConference()
Development environment running
1. Execute the development environment command. (Here we take the vue3 + vite default project as an example. The dev instructions of different projects may be different. Please adjust according to your own project)
2. According to the console prompts, open the page in the browser, such as: http://localhost:3000/.
3. Experience the TUIRoomKit component functions.
Production environment deployment
1. Package the dist file.
2. Deploy the dist file to the server.
Note:
The production environment requires the use of an HTTPS domain name.
Other documents
Communication and feedback
If you have any needs or feedback, you can contact: info_rtc@tencent.com.
