TUIRoomKit
组件的接入,跟随本文档,您将在一个小时内完成如下几个关键步骤,并最终得到一个包含完备 UI 界面的多人音视频房间功能。包括成员管理、屏幕分享、聊天、自由发言申请发言模式等功能,如下图所示:cd electron-vite-vuegit checkout v1.0.0git switch -c TUIRoomKit-quick-startnpm installnpm run dev
// 安装 vue-cli,注意 Vue CLI 4.x 要求 Node.js 为 v10 以上版本npm install -g @vue/cli// 创建 Vue2 + Webpack + TS 模版工程vue create tuiroomkit-demo
TUIRoomKit/Electron/vue3/packages/renderer/src/TUIRoom
文件夹到已有项目 packages/renderer/src/
目录下, 复制 TUIRoomKit/Electron/vue3/packages/renderer/index.html
文件夹到已有项目 packages/renderer/
目录下。App.vue
组件中引入 TUIRoom 组件。<template><room ref="TUIRoomRef"></room></template><script setup lang="ts">import { ref, onMounted } from 'vue';// 引入 TUIRoom 组件,注意确认引入路径是否正确import Room from './TUIRoom/index.vue';// 获取 TUIRoom 组件元素,用于调用 TUIRoom 组件的方法const TUIRoomRef = ref();onMounted(async () => {// 初始化 TUIRoom 组件// 主持人在创建房间前需要先初始化 TUIRoom 组件// 普通成员在进入房间前需要先初始化 TUIRoom 组件await TUIRoomRef.value.init({// 获取 sdkAppId 请您参考 步骤一sdkAppId: 0,// 用户在您业务中的唯一标示 IduserId: '',// 本地开发调试可在 https://console.tencentcloud.com/trtc/usersigtool 页面快速生成 userSig// 注意 userSig 与 userId 为一一对应关系userSig: '',// 用户在您业务中使用的昵称userName: '',// 用户在您业务中使用的头像链接avatarUrl: '',})// 默认执行创建房间,实际接入可按需求择机执行 handleCreateRoom 方法await handleCreateRoom();})// 主持人创建房间,该方法只在创建房间时调用async function handleCreateRoom() {// roomId 为用户进入的房间号, 要求 roomId 类型为 string// roomMode 包含'FreeToSpeak'(自由发言模式) 和'SpeakAfterTakingSeat'(上台发言模式) 两种模式,默认为'FreeToSpeak',注意目前仅支持自由发言模式// roomParam 指定了用户进入房间的默认行为(是否默认开启麦克风,是否默认开启摄像头,默认媒体设备Id)const roomId = '123456';const roomMode = 'FreeToSpeak';const roomParam = {isOpenCamera: true,isOpenMicrophone: true,};const createRoomInfo = {roomId,roomName: 'User defined room name' || roomId,roomMode,roomParam};await TUIRoomRef.value.createRoom(createRoomInfo);}// 普通成员进入房间,该方法在普通成员进入已创建好的房间时调用async function handleEnterRoom() {// roomId 为用户进入的房间号, 要求 roomId 类型为 number// roomParam 指定了用户进入房间的默认行为(是否默认开启麦克风,是否默认开启摄像头,默认媒体设备Id)const roomId = '123456';const roomParam = {isOpenCamera: true,isOpenMicrophone: true,};const enterRoomInfo = {roomId,roomParam};await TUIRoomRef.value.enterRoom(enterRoomInfo);}</script><style>html, body {width: 100%;height: 100%;margin: 0;}#app {width: 100%;height: 100%;}</style>
TUIRoomKit/Electron/vue2/src/TUIRoom
文件夹到已有项目 src/ 目录下。App.vue
组件中引入 TUIRoom 组件。<template><div id="app"><room-container ref="TUIRoomRef"></room-container></div></template><script>import RoomContainer from '@/TUIRoom/index.vue';export default {name: 'App',components: { RoomContainer },data() {return {};},async mounted() {// 初始化 TUIRoom 组件// 主持人在创建房间前需要先初始化 TUIRoom 组件// 普通成员在进入房间前需要先初始化 TUIRoom 组件await this.$refs.TUIRoomRef.init({// 获取 sdkAppId 请您参考 步骤一sdkAppId: 0,// 用户在您业务中的唯一标示 IduserId: '',// 本地开发调试可在 https://console.tencentcloud.com/trtc/usersigtool 页面快速生成 userSig, 注意 userSig 与 userId 为一一对应关系userSig: '',// 用户在您业务中使用的昵称userName: '',// 用户在您业务中使用的头像链接avatarUrl: '',});// 默认执行创建房间,实际接入可按需求择机执行 handleCreateRoom 方法await this.handleCreateRoom();},methods: {// 主持人创建房间,该方法只在创建房间时调用async handleCreateRoom() {// roomId 为用户进入的房间号, 要求 roomId 类型为 string// roomMode 包含'FreeToSpeak'(自由发言模式) 和'SpeakAfterTakingSeat'(上台发言模式) 两种模式,默认为'FreeToSpeak',注意目前仅支持自由发言模式// roomParam 指定了用户进入房间的默认行为(是否默认开启麦克风,是否默认开启摄像头,默认媒体设备Id)const roomId = '123456';const roomMode = 'FreeToSpeak';const roomParam = {isOpenCamera: true,isOpenMicrophone: true,}try {await this.$refs.TUIRoomRef.createRoom({ roomId, roomName: roomId, roomMode, roomParam });} catch (error) {alert('TUIRoomKit.createRoom error: ' + error.message);}},// 普通成员进入房间,该方法在普通成员进入已创建好的房间时调用async handleEnterRoom() {// roomId 为用户进入的房间号, 要求 roomId 类型为 string// roomParam 指定了用户进入房间的默认行为(是否默认开启麦克风,是否默认开启摄像头,默认媒体设备Id)const roomId = '123456';const roomParam = {isOpenCamera: true,isOpenMicrophone: true,}try {await this.$refs.TUIRoomRef.enterRoom({ roomId, roomParam });} catch (error) {alert('TUIRoomKit.enterRoom error: ' + error.message);}}},};</script><style lang="scss">html, body {width: 100%;height: 100%;margin: 0;}#app {width: 100%;height: 100%;* {box-sizing: border-box;}}</style>
npm install sass typescript unplugin-auto-import unplugin-vue-components --save-dev
npm install element-plus events mitt pinia trtc-electron-sdk tim-js-sdk tsignaling vue-i18n @tencentcloud/tuiroom-engine-electron --save
packages/renderer/src/main.ts
文件。// src/main.ts 文件import { createPinia } from 'pinia';const app = createApp(App);// 注册PiniacreateApp(App).use(createPinia()).mount('#app').$nextTick(window.removeLoading)
// vite.config.tsimport AutoImport from 'unplugin-auto-import/vite';import Components from 'unplugin-vue-components/vite';import { ElementPlusResolver } from 'unplugin-vue-components/resolvers';import { createSvg } from './src/TUIRoom/assets/icons/index.js'const path = require('path');export default defineConfig({// ...resolve: {alias: {'@': path.resolve(__dirname, 'src'),'@TUIRoom': path.resolve(__dirname, 'src/TUIRoom'),}},plugins: [// ...createSvg(path.join(path.resolve(__dirname, 'src/TUIRoom/assets/icons/svg/'), '/')),AutoImport({resolvers: [ElementPlusResolver()],}),Components({resolvers: [ElementPlusResolver({importStyle: 'sass',})],}),],optimizeDeps: {include: ['@tencentcloud/tuiroom-engine-electron']},build: {// ...commonjsOptions: {exclude: ['@tencentcloud/tuiroom-engine-electron'],include: [],},}// ...});
// src/main.tsimport 'element-plus/theme-chalk/el-message.css';import 'element-plus/theme-chalk/el-message-box.css';
packages/renderer/vite.config.ts
文件。// vite.config.tsexport default defineConfig({// ...plugins: [resolve({"trtc-electron-sdk": `const TRTCCloud = require("trtc-electron-sdk");const TRTCParams = TRTCCloud.TRTCParams;const TRTCAppScene = TRTCCloud.TRTCAppScene;const TRTCVideoStreamType = TRTCCloud.TRTCVideoStreamType;const TRTCScreenCaptureSourceType = TRTCCloud.TRTCScreenCaptureSourceType;const TRTCVideoEncParam = TRTCCloud.TRTCVideoEncParam;const Rect = TRTCCloud.Rect;const TRTCAudioQuality = TRTCCloud.TRTCAudioQuality;const TRTCScreenCaptureSourceInfo = TRTCCloud.TRTCScreenCaptureSourceInfo;const TRTCDeviceInfo = TRTCCloud.TRTCDeviceInfo;const TRTCVideoQosPreference = TRTCCloud.TRTCVideoQosPreference;const TRTCQualityInfo = TRTCCloud.TRTCQualityInfo;const TRTCQuality = TRTCCloud.TRTCQuality;const TRTCStatistics = TRTCCloud.TRTCStatistics;const TRTCVolumeInfo = TRTCCloud.TRTCVolumeInfo;const TRTCDeviceType = TRTCCloud.TRTCDeviceType;const TRTCDeviceState = TRTCCloud.TRTCDeviceState;const TRTCBeautyStyle = TRTCCloud.TRTCBeautyStyle;const TRTCVideoResolution = TRTCCloud.TRTCVideoResolution;const TRTCVideoResolutionMode = TRTCCloud.TRTCVideoResolutionMode;const TRTCVideoMirrorType = TRTCCloud.TRTCVideoMirrorType;const TRTCVideoRotation = TRTCCloud.TRTCVideoRotation;const TRTCVideoFillMode = TRTCCloud.TRTCVideoFillMode;const TRTCRoleType = TRTCCloud.TRTCRoleType;const TRTCScreenCaptureProperty = TRTCCloud.TRTCScreenCaptureProperty;export {TRTCParams,TRTCAppScene,TRTCVideoStreamType,TRTCScreenCaptureSourceType,TRTCVideoEncParam,Rect,TRTCAudioQuality,TRTCScreenCaptureSourceInfo,TRTCDeviceInfo,TRTCVideoQosPreference,TRTCQualityInfo,TRTCStatistics,TRTCVolumeInfo,TRTCDeviceType,TRTCDeviceState,TRTCBeautyStyle,TRTCVideoResolution,TRTCVideoResolutionMode,TRTCVideoMirrorType,TRTCVideoRotation,TRTCVideoFillMode,TRTCRoleType,TRTCQuality,TRTCScreenCaptureProperty,};export default TRTCCloud.default;`}),// ...]// ...});
packages/renderer/src/env.d.ts
中配置。以下配置项为增量配置,不要删除已经存在的 env.d.ts
文件配置。// env.d.tsdeclare module '*.vue' {import { DefineComponent } from 'vue'// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-typesconst component: DefineComponent<{}, {}, any>export default component}declare module 'tsignaling/tsignaling-js' {import TSignaling from 'tsignaling/tsignaling-js';export default TSignaling;}declare module 'tim-js-sdk' {import TIM from 'tim-js-sdk';export default TIM;}declare const Aegis: any;
// src/main.ts// 引入 locales/index.ts 文件,请确认引入路径是否正确import VueI18n from './TUIRoom/locales/index';createApp(App).use(createPinia()).use(VueI18n).mount('#app').$nextTick(window.removeLoading);
npm install sass sass-loader -S -D
npm install vue@^2.7 element-ui pinia trtc-electron-sdk tim-js-sdk tsignaling @tencentcloud/tuiroom-engine-electron vue-i18n@^8 vue-i18n-bridge -S
src/main.ts
文件。import { createPinia, PiniaVuePlugin } from 'pinia';Vue.use(PiniaVuePlugin);const pinia = createPinia();new Vue({pinia,render: h => h(App),}).$mount('#app');
src/main.ts
或src/main.js
中注册 element-ui 组件并引用其样式文件。import ElementUI from 'element-ui';import 'element-ui/lib/theme-chalk/index.css';Vue.use(ElementUI);
import i18n from './TUIRoom/locales/';Vue.use(i18n);
vue add typescript
npm install sass sass-loader -S -D
npm install vue@^2.7 element-ui pinia trtc-electron-sdk tim-js-sdk tsignaling @tencentcloud/tuiroom-engine-electron vue-i18n@^8 vue-i18n-bridge -S
src/main.ts
文件。import { createPinia, PiniaVuePlugin } from 'pinia';Vue.use(PiniaVuePlugin);const pinia = createPinia();new Vue({pinia,render: h => h(App),}).$mount('#app');
src/main.ts
中注册 element-ui 组件并引用其样式文件。import ElementUI from 'element-ui';import 'element-ui/lib/theme-chalk/index.css';Vue.use(ElementUI);
import i18n from './TUIRoom/locales/';Vue.use(i18n);
npm run dev
npm run start
main.electron.js
中修改对应端口号即可。npm run build
本页内容是否解决了您的问题?