集成指引
1. 下载并解压 TencentEffect_UniApp。
2. 找到 TencentEffect_UniApp/SDK/nativeplugins 目录下的 TencentEffectUniPlugin-XmagicPluginImpl 文件夹拷贝到自己项目工程的 nativeplugins 目录下。如下图所以位置 :
3. 在自己项目工程的 manifest.json 中配置原生插件,选择本地插件 TencentEffectUniPlugin-XmagicPluginImpl。
4. 把 SDK/js 目录下的 XMagic 文件夹拷贝到自己项目工程中。
5. 添加美颜素材和模型:
Android:把在官网中下载的美颜素材拷贝到自己项目工程的 nativeResources/android/assets 目录下。
iOS:把在官网中下载的美颜资源和美颜模型拷贝到自己项目工程的 nativeResources/ios/Resources 目录下。
6. 添加腾讯特效 SDK
Android:通过 maven 依赖美颜特效 SDK,需要更改美颜套餐或者美颜版本,可手动修改
nativeplugins/TencentEffectUniPlugin-XmagicPluginImpl/package.json
中dependencies
字段中腾讯特效 SDK 的 maven 地址。
iOS:下载腾讯特效 SDK 后,把里面的 XMagic.framework、YTCommonXMagic.framework、TECodec.framework、libpag.framework 拷贝到
nativeplugins/TencentEffectUniPlugin-XmagicPluginImpl/ios
中。
使用指引
注:此美颜插件需要和 TRTC 插件结合使用,按照顺序调用对应方法。
1. 复制美颜资源
接口:
copyXmaigcRes
描述:复制美颜资源。
app 首次安装使用时,需要调用此接口把美颜资源复制到沙盒,每个版本仅需要成功调用一次即可。
2. 美颜鉴权
接口:
setLicense
描述:使用 bundleId、licenseUrl、licenseKey 进行美颜鉴权。
app 启动以后,需要成功鉴权以后才能使用美颜功能。
3. 开启或关闭美颜
接口:
enableCustomVideoProcess
描述:调用此接口来开启或关闭美颜。
注意:关闭美颜需要在关闭TRTC 预览之前进行。
4. 设置美颜属性
接口:
setEffect
描述:设置美颜属性。
美颜属性包括美颜、美体、滤镜、动效(2D 动效、3D 动效、手势动效、趣味动效)、美妆、分割。设置不同的属性需要在调用此接口时传入不同的参数,
接口:
updateProperty
(已废弃)描述:设置美颜属性。
美颜属性包括美颜、美体、滤镜、动效(2D 动效、3D 动效、手势动效、趣味动效)、美妆、分割。设置不同的属性需要在调用此接口时传入不同的参数,具体参数请参见下表和 demo。
字段 | 美颜 | 滤镜 | 美体 | 动效贴纸 | 分割 | 美妆 |
category | Category.BEAUTY | Category.LUT | Category.BODY_BEAUTY | Category.MOTION | Category.SEGMENTATION | Category.MAKEUP |
id | 参考 PropertyIds 类 | 滤镜资源名称 例如:baixi_lf.png | 无 | 贴纸资源的名称。例如:video_keaituya | 分割资源的名称 例如:video_segmentation_blur_45 | 美妆资源名称 例如:video_nvtuanzhuang |
resPath | 滤镜资源的路径 例如:light_material/lut/baixi_lf.png | 无 | 贴纸资源名称。例如:MotionRes/2dMotionRes/video_keaituya | 分割资源路径。 例如:MotionRes/segmentMotionRes/video_segmentation_blur_45 | 美妆资源路径 例如:
MotionRes/makeupRes/video_nvtuanzhuang | |
effKey | 参考 EffectName 类 | 无 | 参考 EffectName 类 | 无 | 无 | 无 |
effValue | 取值范围为0 - 1或者是-1 - 1 参考Android 参数表,如果 displayMinValue 和 displayMaxValue 值为0 - 100,那么此处的范围是0 - 1,如果是-100 - 100,那么此处的值为-1 - 1 | 0 - 1 | 0 - 1 | 无 | 无 | 0 - 1 |
5. 暂停美颜
接口:
onPause
描述:暂停美颜音频。
6. 恢复美颜
接口:
onResume
描述:恢复美颜音频。