tencent cloud

腾讯特效 SDK

动态与公告
产品动态
关于腾讯特效 SDK V3.5 版本更新公告
关于腾讯特效 SDK V3.0 版本相关接口及素材变更公告
产品简介
产品概述
产品功能
基本概念
产品优势
应用场景
购买指南
价格总览
购买流程
欠费退费说明
新手指引
Demo 体验
免费测试
License 指引
移动端 License 新增与续期
PC 端 License 新增与续期
Web端 License 新增与续期
常见问题
SDK 下载
功能说明
SDK 下载
版本历史
SDK 集成指引(无 UI)
通用集成腾讯特效
原子能力集成指引
SDK 集成指引(含 UI)
通用集成腾讯特效
直播 SDK 集成腾讯特效
TRTC SDK 集成腾讯特效
短视频 SDK 集成腾讯特效
Avatar 虚拟人集成指引
API 文档
iOS
Android
Flutter
Web
功能实践
SDK 包瘦身
SDK 集成问题排查
性能调优
效果调优
素材使用
美颜参数说明
美颜场景推荐参数
短视频企业版迁移指引
第三方推流接入美颜(Flutter)
小程序美颜特效实践
素材制作工具使用
Web 美颜特效
产品概述
快速上手
SDK 接入
API 文档
控制台指南
Demo 体验
内置素材总览
实践教程
常见问题
常见问题
通用类相关
技术类相关
License 相关
旧版文档
美颜场景推荐参数
美颜参数表
一分钟集成 TRTC
一分钟集成直播
TE SDK 政策
隐私协议
数据处理和安全协议
联系我们

开始

PDF
聚焦模式
字号
最后更新时间: 2025-05-16 15:46:43
本文档指导您快速、安全地接入 Web 美颜特效,并使用相关功能。在接入使用过程中,您有任何疑问可进群进行 技术咨询

前期准备

准备接入 SDK 使用之前,需要确保您已购买 Web License 并创建项目,详情参见 Web端 License 新增与续期

获取参数信息

获取 License Key 和 Token
进入音视频终端 SDK 控制台 > License 管理 > Web License管理,查看您已创建的 Web License 并复制其 License Key 和 Token。



Web Domain:创建项目时填写的域名信息,只可以在该域名下使用此 License。
注意:
请确保使用与实际应用 Domain 匹配的 License Key 和 Token,否则鉴权会失败,无法正常初始化 SDK。
获取 APPID
您可以登录腾讯云控制台,进入账号信息 > 基本信息 查看 APPID。




准备签名信息

除了需要上述 License Key 授权 SDK 外,还需要使用 Token 对 SDK 中调用的接口进行签名。

签名方法鉴权流程




Token:用于 SDK 接口签名,是您身份的唯一标识。
appid:即腾讯云控制台 账号信息 > 基本信息 展示的 APPID。
timestamp:当前时间戳,精确到秒(10位数字)。 
signature:签名(签名有时效性,目前5分钟过期)。

部署签名服务

由于 signature 有时效性,且需要防止 Token 泄露,您需要部署一个生成签名的服务。
注意:
如果 Token 泄露您的身份会被盗用,您的资源会泄露。
生成签名的方法放在前端会导致 Token 泄露,为了避免利益受损,建议您不要将生成签名的方法放在前端。
// 以express后台为例
// 签名方法: sha256(timestamp+token+appid+timestamp)

const { createHash } = require('crypto');
const config = {
appid: '您的腾讯云APPID',
token: '您的Token',
}
const sha256 = function(str) {
return createHash('sha256')
.update(str)
.digest('hex');
}

const genSignature = function() {
const timestamp = Math.round(new Date().getTime() / 1000);
const signature = sha256(timestamp + config.token + config.appid + timestamp).toUpperCase(); // 使用上面获取到的token和appid合成加密串返回
return { signature, timestamp };
}

app.get("/get-ar-sign", (req, res) => {
const sign = genSignature();
res.setHeader('Access-Control-Allow-Origin','*');
res.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');
res.send(sign);
})

前端调用签名服务

获取签名的服务部署完成后,在您的 Web 页面中,添加一个获取签名的方法供 SDK 接入调用。
Web
async function getSignature() {
const res = await fetch('您的域名/get-ar-sign')
const authdata = await res.json()
console.log('authdata',authdata)
return authdata
}

SDK 接入

上述准备工作完成后,便可根据如下流程接入并使用 SDK。

流程说明

SDK 实现了简洁低侵入性的接口提供接入,您只需要初始化实例,将渲染节点添加到自己的页面即可快速实现 Web 美颜特效功能。




安装 SDK

使用 npm 包接入 SDK。
npm install tencentcloud-webar
此外,也可以通过引入 JS 的方式使用,可以根据自身项目灵活选择。
<script charset="utf-8" src="https://webar-static.tencent-cloud.com/ar-sdk/resources/latest/webar-sdk.umd.js"></script>

初始化 SDK

Web 端我们提供了内置 Camera 与自定义流两种初始化方式。
内置相机与播放器:使用了内置的摄像头与播放器封装,调用简单迅速,交互功能丰富。
自定义流接入:适用于有自己维护媒体流的需求或者要求更高的灵活性与可控性的场景。

使用 SDK

设置美颜和特效
详情可参见 设置美颜和特效
人像分割(0.2.0版本新增)
详情请参见 使用人像分割
3D特效(0.3.0版本新增)
详情请参见 设置美颜和特效
Animoji 表情与虚拟形象(0.3.0版本新增)
依赖 WebGL2 运行环境,详情请参见 使用表情和虚拟形象

参数与方法说明

请参见 API 文档

代码示例

请参见 快速上手

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈