Web&H5(Vue2/Vue3)

最近更新时间:2024-09-26 16:47:21

我的收藏
本文将介绍如何快速完成 TUICallKit 组件的接入,您将在10分钟内完成以下几个关键步骤,并最终得到一个包含完备 UI 界面的视频通话功能。




环境准备

Node.js version 16+.
Modern browser, supporting WebRTC APIs.
npm 包集成
Vue3 开发环境,集成 @tencentcloud/call-uikit-vue NPM 包。
Vue2.7 开发环境:集成 @tencentcloud/call-uikit-vue2 NPM 包。
Vue2.6 开发环境:集成 @tencentcloud/call-uikit-vue2.6 + @vue/composition-api NPM 包。
源码集成
Vue3 + TypeScript 开发环境:从 @tencentcloud/call-uikit-vue NPM 包拷贝源码。
Vue2.7 + TypeScript 开发环境:从 @tencentcloud/call-uikit-vue2 NPM 包拷贝源码。
Vue2.6 + TypeScript 开发环境:从 @tencentcloud/call-uikit-vue2.6 NPM 包拷贝源码。
注意:
1. HBuilderX 中选择 vue2 时,使用的是 vue2.6,因此需要使用:@tencentcloud/call-uikit-vue2.6
2. HBuilderX 中选择 vue3 时,使用的是 vue3,因此需要使用:@tencentcloud/call-uikit-vue

步骤一:开通服务

请参见开通服务,获取 SDKAppID、SecretKey,他们将在 初始化 TUICallKit 组件 作为必填参数使用。

步骤二:下载 TUICallKit 组件

推荐使用 NPM 集成,如果您需要采用源码集成,请参见 TUICallKit 源码集成
说明:
如果您的工程同时使用了 TUIChat UIKit,请直接移步 TUIKit 接入音视频通话 进行接入。
1. 下载 @tencentcloud/call-uikit-vue 组件。
Vue3
Vue2.7
Vue2.6
npm install @tencentcloud/call-uikit-vue
npm install @tencentcloud/call-uikit-vue2
npm install @tencentcloud/call-uikit-vue2.6 @vue/composition-api
如果是源码集成还需要安装 unplugin-vue2-script-setup
npm i -D unplugin-vue2-script-setup
2. debug 目录复制到您的项目目录 src/debug,本地生成 userSig 时需要使用。
Vue3
Vue2.7
Vue2.6
MacOS 端
Windows 端
cp -r node_modules/@tencentcloud/call-uikit-vue/debug ./src
xcopy node_modules\\@tencentcloud\\call-uikit-vue\\debug .\\src\\debug /i /e
MacOS 端
Windows 端
cp -r node_modules/@tencentcloud/call-uikit-vue2/debug ./src
xcopy node_modules\\@tencentcloud\\call-uikit-vue2\\debug .\\src\\debug /i /e
MacOS 端
Windows 端
cp -r node_modules/@tencentcloud/call-uikit-vue2.6/debug ./src
xcopy node_modules\\@tencentcloud\\call-uikit-vue2.6\\debug .\\src\\debug /i /e

步骤三:初始化 TUICallKit 组件

说明:
TUICallKit 组件需要放到一个 dom 节点里,用于控制 TUICallKit 的位置、宽高等样式。
1. 引入 <TUICallKit />,该组件包含通话时的完整 UI 交互。
<template>
<div>
<span> caller's ID: </span>
<input type="text" v-model="callerUserID">
<button @click="init"> step1. init </button> <br>
<span> callee's ID: </span>
<input type="text" v-model="calleeUserID">
<button @click="call"> step2. call </button>
<!--【1】Import the TUICallKit component: Call interface UI -->
<TUICallKit style="width: 650px; height: 500px " />
</div>
</template>
2. 调用 TUICallKitServer.init API 登录组件,需要在代码中填写 SDKAppID、SecretKey 两个参数。
Vue3
Vue2.7
Vue2.6
您可以选择在 src/App.vue 文件引入示例代码,示例代码采用的是 Vue3 Composition API写法。
import { ref } from 'vue';
import { TUICallKit, TUICallKitServer, TUICallType } from "@tencentcloud/call-uikit-vue";
import * as GenerateTestUserSig from "./debug/GenerateTestUserSig-es"; // Refer to Step 3

const SDKAppID = 0; // TODO: Replace with your SDKAppID (Notice: SDKAppID is of type number)
const SecretKey = 'xx'; // TODO: Replace with your SecretKey

const callerUserID = ref('');
const calleeUserID = ref('');

//【2】Initialize the TUICallKit component
const init = async () => {
const { userSig } = GenerateTestUserSig.genTestUserSig({
userID: callerUserID.value,
SDKAppID,
SecretKey: SecretKey,
});
await TUICallKitServer.init({
userID: callerUserID.value,
userSig,
SDKAppID,
// tim: this.tim // 如果工程中已有 tim 实例,需在此处传入
});
alert('TUICallKit init succeed');
}
</script>
import { TUICallKit, TUICallKitServer, TUICallType } from "@tencentcloud/call-uikit-vue2";
import * as GenerateTestUserSig from "./debug/GenerateTestUserSig-es";

export default {
name: 'App',
data() {
return {
callerUserID: '',
calleeUserID: '',
SDKAppID: 0, // TODO: Replace with your SDKAppID
SecretKey: 'xx', // TODO: Replace with your SecretKey
};
},
components: {
TUICallKit
},
methods: {
//【2】Initialize the TUICallKit component
async init() {
try {
const { userSig } = GenerateTestUserSig.genTestUserSig({
userID: this.callerUserID,
SDKAppID: Number(this.SDKAppID),
SecretKey: this.SecretKey,
});
await TUICallKitServer.init({
SDKAppID: Number(this.SDKAppID),
userID: this.callerUserID,
userSig,
// tim: this.tim // 如果工程中已有 tim 实例,需在此处传入
});
alert("[TUICallKit] Initialization succeeds.");
} catch (error) {
alert(`[TUICallKit] Initialization failed. Reason: ${error}`);
}
},
}
}

1. main.ts 文件注册 @vue/composition-api
main.ts
import Vue from 'vue'
import VueCompositionAPI from '@vue/composition-api'
Vue.use(VueCompositionAPI)
2. 将下面代码直接复制引用在 App.vue 文件中。
import { TUICallKit, TUICallKitServer, TUICallType } from "@tencentcloud/call-uikit-vue2.6";
import * as GenerateTestUserSig from "./debug/GenerateTestUserSig-es";

export default {
name: 'App',
data() {
return {
callerUserID: '',
calleeUserID: '',
SDKAppID: 0, // TODO: Replace with your SDKAppID
SecretKey: 'xx', // TODO: Replace with your SecretKey
};
},
components: {
TUICallKit
},
methods: {
//【2】Initialize the TUICallKit component
async init() {
try {
const { userSig } = GenerateTestUserSig.genTestUserSig({
userID: this.callerUserID,
SDKAppID: Number(this.SDKAppID),
SecretKey: this.SecretKey,
});
await TUICallKitServer.init({
SDKAppID: Number(this.SDKAppID),
userID: this.callerUserID,
userSig,
// tim: this.tim // 如果工程中已有 tim 实例,需在此处传入
});
alert("[TUICallKit] Initialization succeeds.");
} catch (error) {
alert(`[TUICallKit] Initialization failed. Reason: ${error}`);
}
},
}
}
参数
类型
说明
userID
String
用户的唯一标识符,由您定义,只允许包含大小写英文字母(a-z A-Z)、数字(0-9)及下划线和连词符。
SDKAppID
Number
Tencent RTC 控制台 创建的音视频应用的唯一标识。
SDKSecretKey
String
Tencent RTC 控制台 创建的音视频应用的 SecretKey。
userSig
String
一种安全保护签名,用于对用户进行登录鉴权认证,确认用户是否真实,阻止恶意攻击者盗用您的云服务使用权。
userSig 说明:
开发环境:如果您正在本地跑通 Demo、开发调试,可以采用 debug 文件中的 genTestUserSig(参考步骤3.2)函数生成 userSig。该方法中 SDKSecretKey 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量。
生产环境:如果您的项目要发布上线,请采用 服务端生成 UserSig 的方式。

步骤四:拨打您的第一通电话

1. 调用 TUICallKitServer.call API 拨打通话。
Vue3
Vue2.7
Vue2.6
//【3】Make a 1v1 video call
const call = async () => {
await TUICallKitServer.call({
userID: calleeUserID.value,
type: TUICallType.VIDEO_CALL,
});
};
//【3】Make a 1v1 video call
async call () {
await TUICallKitServer.call({
userID: this.calleeUserID,
type: TUICallType.VIDEO_CALL,
});
}
//【3】Make a 1v1 video call
async call () {
await TUICallKitServer.call({
userID: this.calleeUserID,
type: TUICallType.VIDEO_CALL,
});
}
2. 运行项目。
警告:
本地环境请在 localhost 协议下访问,公网体验请在 HTTPS 协议下访问,具体参见 网络访问协议说明
3. 打开两个浏览器页面,输入不同的 userID(由您定义) 单击 step1. init登录(主叫方和被叫方)。



4. 两个 userID 都登录成功后,单击 step2. call 拨打通话,如果您有通话问题,参见 常见问题




更多特性

悬浮窗

常见问题

如果您的接入和使用中遇到问题,请参见 常见问题
了解更多详情,请到 腾讯云通信官方社群 进行咨询和反馈。