tencent cloud

Feedback

Integrating TUIRoom (Web)

Last updated: 2022-07-22 17:41:21

    Overview

    TUIRoom is an open-source audio/video component that comes with UI elements. It allows you to quickly integrate conference capabilities including screen sharing and chat into your project.

    Note:

    All components of TUIKit use two basic PaaS services of Tencent Cloud, namely TRTC and IM. When you activate TRTC, IM and the trial edition of the IM SDK (which supports up to 100 DAUs) will be activated automatically. For the billing details of IM, see Pricing.

    Click here to try out more features of TUIRoom.
    Click here to download the TUIRoom code and refer to this document to run the TUIRoom web demo.
    This document shows you how to integrate the TUIRoom web 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 Vue 3 + TypeScript.

    Step 1. Activate the TRTC service

    TUIRoom is based on TRTC and IM.

    1. Create a TRTC application

      • If you don’t have a Tencent Cloud account yet, sign up for one first.
      • In the TRTC console, click Application Management on the left sidebar and then click Create Application.
    2. Get the SDKAppID and key

    3. 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).

    4. 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.

    5. Generate UserSig
      UserSig 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.

    Step 2. Download and copy the TUIRoom component

    1. Click here to clone or download the TUIRoom repository code.
    2. Open your Vue3 + TypeScript project. You can use the build tool Vite or Webpack. If you don’t have a Vue3 + TypeScript project, create a template using either of the following two methods:

      npm create vite@latest TUIRoom-demo -- --template vue
      

      Note

      During the creation process, press Enter first, select "Vue", and then select "vue-ts".

      After the template is generated, run the script below:

      cd TUIRoom-demo
      npm install
      npm run dev
      

    3. Copy the TUIRoom/Web/src/TUIRoom folder to the project's src/ directory.

    Step 3. Import the TUIRoom component

    1. Import the TUIRoom component into your webpage, such as App.vue.
      • The TUIRoom component classifies users as hosts and members and offers APIs including init, createRoom, and enterRoom.
      • Hosts and members can call init to initialize application and user data. Hosts can call createRoom to create and enter rooms. Members 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 member 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. Note that `userSig` and `userId` have a one-to-one correspondence.
        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()
    await handleCreateRoom();
    })
    // The host creates a room. Call this API only when you need to create a room.
    async function handleCreateRoom() {
    // `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
    const roomId = 123456;
    const roomMode = 'FreeSpeech';
    const roomParam = {
        isOpenCamera: true,
        isOpenMicrophone: true,
    }
    await TUIRoomRef.value.createRoom(roomId, roomMode, roomParam);
    }
    // The member enters a room. This API is called by a member to join an existing room.
    async function handleEnterRoom() {
    // `roomId` is the ID of the room entered by the user, which must be a number.
    // `roomParam` specifies whether to turn on the mic/camera upon room entry, as well as the default media device ID to use
    const roomId = 123456;
    const roomParam = {
        isOpenCamera: true,
        isOpenMicrophone: true,
    }
    await TUIRoomRef.value.enterRoom(roomId, roomParam);
    }
    </script>
    <style>
    html, body {
    width: 100%;
    height: 100%;
    margin: 0;
    }
    #app {
    width: 100%;
    height: 100%;
    }
    </style>
    
    Note:

    Copy the above code to your webpage and replace the parameter values for the APIs with the actual values.

    Step 4. Configure the development environment

    After the TUIRoom component is imported, in order to ensure that the project can run normally, the following configurations are required:

    1. Install dependencies
    • Install development environment dependencies:
      npm install sass typescript unplugin-auto-import unplugin-vue-components -S -D
      
    • Install production environment dependencies:
      npm install element-plus events mitt pinia rtc-beauty-plugin tim-js-sdk trtc-js-sdk tsignaling -S
      
    1. Register Pinia
      TUIRoom uses Pinia for room data management. You need to register Pinia in the project entry file src/main.ts.
      // `src/main.ts` file
      import { createPinia } from 'pinia';
      const app = createApp(App);
      // Register Pinia
      app.use(createPinia()); 
      app.mount('#app');
      
    2. Import Element Plus components
    • TUIRoom uses Element Plus UI components, which you need to import in vite.config.ts. You can import only the components you need.
      Note

      Add the code in the file. Do not delete the existing configuration.


      // vite.config.ts
      import AutoImport from 'unplugin-auto-import/vite';
      import Components from 'unplugin-vue-components/vite';
      import { ElementPlusResolver } from 'unplugin-vue-components/resolvers';
      export default defineConfig({
      // ...
      plugins: [
      AutoImport({
          resolvers: [ElementPlusResolver()],
      }),
      Components({
          resolvers: [ElementPlusResolver({
              importStyle: 'sass',
          })],
      }),
      ],
      css: {
      preprocessorOptions: {
          scss: {
              // ...
              additionalData: `
                  @use "./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 src/main.ts.
      // src/main.ts
      import 'element-plus/theme-chalk/el-message.css';
      import 'element-plus/theme-chalk/el-message-box.css';
      

    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 create a Vue + Vite + TypeScript project, follow the steps below:
    1. Run the development environment command.

      npm run dev
      
    2. Open http://localhost:3000/ in a browser.

      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 packaging.

    3. Try out the features of the TUIRoom component.

    • If you used the script in step 2 to create a Vue + Webpack + TypeScript project, follow the steps below:
    1. Run the development environment command.
      npm run serve
      
    1. Open http://localhost:8080/ in a browser.

      Note:

      If an ESLint error occurs in the src/TUIRoom directory, you can disable ESLint by adding /src/TUIRoom to the .eslintignore file.

    2. Try out the features of the TUIRoom component.

    Appendix: TUIRoom APIs

    TUIRoom APIs

    init

    This API is used to initialize TUIRoom data. All users using TUIRoom need to call this API first.

    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 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 UserSig used for screen sharing, which is optional.

    createRoom

    This API is used by a host to create a room.

    TUIRoomRef.value.createRoom(roomId, roomMode, roomParam);
    

    The parameters are described below:

    Parameter Type Description
    roomId number The room ID.
    roomMode string 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 member 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.
    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.

    TUIRoom events

    onRoomCreate

    A room was created.

    <template>
     <room ref="TUIRoomRef" @on-room-create="handleRoomCreate"></room>
    </template>
    <script setup lang="ts">
     // Import the `TUIRoom` component. Be sure to use the correct import path.
     import Room from './TUIRoom/index.vue';
     
     function handleRoomCreate(info) {
       if (info.code === 0) {
         console.log('Room created successfully')
       }
     }
    </script>
    

    onRoomEnter

    A member entered the room.

    <template>
     <room ref="TUIRoomRef" @on-room-enter="handleRoomEnter"></room>
    </template>
    <script setup lang="ts">
     // Import the `TUIRoom` component. Be sure to use the correct import path.
     import Room from './TUIRoom/index.vue';
     
     function handleRoomEnter(info) {
       if (info.code === 0) {
         console.log('Entered room successfully')
       }
     }
    </script>
    

    onRoomDestory

    The host closed the room.

    <template>
     <room ref="TUIRoomRef" @on-room-destory="handleRoomDestory"></room>
    </template>
    <script setup lang="ts">
     // Import the `TUIRoom` component. Be sure to use the correct import path.
     import Room from './TUIRoom/index.vue';
     
     function handleRoomDestory(info) {
       if (info.code === 0) {
         console.log('The host closed the room successfully')
       }
     }
    </script>
    

    onRoomExit

    A member exited the room.

    <template>
    <room ref="TUIRoomRef" @on-room-exit="handleRoomExit"></room>
    </template>
    <script setup lang="ts">
    // Import the `TUIRoom` component. Be sure to use the correct import path.
    import Room from './TUIRoom/index.vue';
    
    function handleRoomExit(info) {
      if (info.code === 0) {
        console.log('The member exited the room successfully')
      }
    }
    </script>
    

    onKickOff

    A member was removed from the room by the host.

    <template>
    <room ref="TUIRoomRef" @on-kick-off="handleKickOff"></room>
    </template>
    <script setup lang="ts">
    // Import the `TUIRoom` component. Be sure to use the correct import path.
    import Room from './TUIRoom/index.vue';
    
    function handleKickOff(info) {
      if (info.code === 0) {
        console.log('The member was removed from the room by the host')
      }
    }
    </script>
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support