tencent cloud

腾讯特效 SDK

文档腾讯特效 SDKSDK 集成指引（含 UI）TRTC SDK 集成腾讯特效Flutter

Flutter

Download
聚焦模式
字号
最后更新时间： 2026-05-15 16:13:51
美颜 Flutter 版本 SDK 需要依赖 Android/iOS 端的美颜 SDK。通过 Flutter 提供的 Plugin 方式，可以将原生端的功能暴露给 Flutter 端。因此，在集成美颜功能时，需要手动集成原生端的 SDK。

跑通 Demo

下载 Demo 工程，修改 demo/lib 下的 main.dart 文件，在此文件中添加您的 licenseUrl 和 licenseKey。TRTC 中使用美颜的示例代码主要在 demo/lib/page/trtc_page.dart 和 demo/lib/main.dart 中。
Android
iOS
1. 在 demo/app 下找到 build.gradle 文件，打开文件，将 applicationId 的值修改为您申请 license 信息时填写的包名。
2. 在 demo/lib 下执行 flutter pub get 。
3. 使用 Android Studio 打开 demo 工程并运行。
1. 在 demo 下执行 flutter pub get。
2. 在 demo/ios 目录下执行 pod install。
3. 使用 Xcode 工具打开 Runner.xcworkspace。
4. 修改工程的 bundle ID（需要和申请 license 时填写的 bundle ID 一致）。

SDK 集成

原生端集成

Android
iOS
1. 在您工程下的 app 模块下找到 build.gradle 文件，添加您对应套餐的 maven 引用地址。例如您选择的是 S1-04套餐，则添加如下：
dependencies {
         implementation 'com.tencent.mediacloud:TencentEffect_S1-04:latest.release'
  }
各套餐对应的 maven 地址，请参见 文档，SDK 的最新版本号可以在 版本历史 中查看。
2. 在您工程下的 android/app 模块下找到 src/main/assets 文件夹，将 demo 工程中 demo/android/app/src/main/assets 中的 lut 和 MotionRes 复制到您工程的 android/app/src/main/assets 中，如果您的工程没有 assets 文件夹可以手动创建一个。
3. 如果您使用的 Android 版美颜 SDK 小于3.9版本，您需要在 app 模块下找到 AndroidManifest.xml 文件，在 application 表内添加如下标签。
  <uses-native-library
            android:name="libOpenCL.so"
            android:required="false" />
        //true 表示libOpenCL是当前app必需的。如果没有此库，系统将不允许app安装
        //false 表示libOpenCL不是当前app必需的。无论有没有此库，都可以正常安装app。如果设备有此库，腾讯特效SDK里的GAN类型特效能正常生效（例如童话脸、国漫脸）。如果设备没有此库，GAN类型不会生效，但也不影响SDK内其他功能的使用。
        //关于uses-native-library的说明，请参考Android 官网介绍：https://developer.android.com/guide/topics/manifest/uses-native-library-element
添加后如下图：



4. 混淆配置：
如果您在打 release 包时，启用了编译优化（把 minifyEnabled 设置为 true），会裁掉一些未在 Java 层调用的代码，而这些代码有可能会被 native 层调用，从而引起 no xxx method 的异常。
如果您启用了这样的编译优化，那就要添加这些 keep 规则，防止 xmagic 的代码被裁掉：
-keep class com.tencent.xmagic.** { *;}
-keep class org.light.** { *;}
-keep class org.libpag.** { *;}
-keep class org.extra.** { *;}
-keep class com.gyailib.**{ *;}
-keep class com.tencent.cloud.iai.lib.** { *;}
-keep class com.tencent.beacon.** { *;}
-keep class com.tencent.qimei.** { *;}
-keep class androidx.exifinterface.** { *;}
-keep class com.tencent.effect.** { *;}
将 demo 工程中 ios/Runner 目录下的 xmagic 文件夹复制到您工程中 ios/Runner 目录下，添加后如下图：



注意：
上述从 demo 工程中复制的素材是测试素材，正式素材需要您在购买套餐之后联系我们 工作人员 进行获取并重新添加。
iOS 项目中添加素材需要在 Xcode 中操作，通过 Add Files to “Runner”手动引入，在 Build Phase — Copy Bundle Resources 中确认是否引入成功。

Flutter 端集成

方式1：
远程依赖，在您工程的 pubspec.yaml 文件中添加如下引用：
  tencent_effect_flutter:
   git:
     url: https://github.com/Tencent-RTC/TencentEffect_Flutter
方式2：
本地依赖，从 tencent_effect_flutter 下载最新版本的 tencent_effect_flutter，然后把文件夹 android、ios、lib 和文件 pubspec.yaml、tencent_effect_flutter.iml 添加到工程目录下，然后在工程的 pubspec.yaml 文件中添加如下引用：（可参考 demo）
tencent_effect_flutter:
    path: ../
执行如下命令
flutter pub get
注意：
tencent_effect_flutter 只是提供一个桥接，美颜功能依赖各个平台提供的美颜 SDK，所以如果需要更新美颜 SDK，您可以通过以下步骤进行 SDK 升级：
Android
iOS
在您的工程下的 app 模块下找到 build.gradle 文件，将 implementation 'com.tencent.mediacloud:TencentEffect_S1-04:latest.release' 中的 latest.release 字段修改为最新的版本号。
如果您需要更换套餐，那么需要将 TencentEffect_S1-04 字段修改为您的套餐字段 。
需要更换套餐类型和 SDK 版本：
1. 美颜 Flutter SDK 的依赖方式需要修改为本地依赖
1. 在美颜 Flutter SDK 下找到 ios/tencent_effect_flutter.podspec 文件，打开找到 TencentEffect_All 修改为您需要的套餐，后边的版本号也可以修改为您需要的版本号。
2. 在您工程的ios目录下执行 pod update 命令即可。

SDK 使用

1. 与 RTC 关联

与tencent_rtc_sdk关联
与tencent_trtc_cloud关联
Android
iOS
在 FlutterActivity 的 onCreate 方法中添加如下代码：
Java
Kotlin
TRTCPlugin.setBeautyProcesserFactory(new XmagicProcesserFactory());
TRTCPlugin.setBeautyProcesserFactory(XmagicProcesserFactory())
如下：
Java
Kotlin
import android.os.Bundle;
import androidx.annotation.Nullable;
import com.tencent.trtcplugin.TRTCPlugin;
import com.tencent.effect.tencent_effect_flutter.XmagicProcesserFactory;
import io.flutter.embedding.android.FlutterActivity;

public class MainActivity extends FlutterActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        TRTCPlugin.setBeautyProcesserFactory(new XmagicProcesserFactory());
    }
}
import android.os.Bundle
import android.os.PersistableBundle
import com.tencent.trtcplugin.TRTCPlugin
import io.flutter.embedding.android.FlutterActivity
import com.tencent.effect.tencent_effect_flutter.XmagicProcesserFactory

class MainActivity: FlutterActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        TRTCPlugin.setBeautyProcesserFactory(XmagicProcesserFactory())
    }
}
在 ios/Runner 目录的 AppDelegate 文件中的 didFinishLaunchingWithOptions 方法中添加如下代码：
Swift
Object-C
let instance = XmagicProcesserFactory()
TencentRTCCloud.setBeautyProcesserFactory(factory: instance)
XmagicProcesserFactory *instance = [[XmagicProcesserFactory alloc] init];
[TencentRTCCloud setBeautyProcesserFactoryWithFactory:instance];
如下：
Swift
Object-C
import UIKit
import Flutter
import tencent_rtc_sdk
import tencent_effect_flutter

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
      let instance = XmagicProcesserFactory()
      TencentRTCCloud.setBeautyProcesserFactory(factory: instance)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

#import "AppDelegate.h"
#import "GeneratedPluginRegistrant.h"
@import tencent_effect_flutter;
@import tencent_rtc_sdk;
@implementation AppDelegate


- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     [GeneratedPluginRegistrant registerWithRegistry:self];
     XmagicProcesserFactory *instance = [[XmagicProcesserFactory alloc] init];
     [TencentRTCCloud setBeautyProcesserFactoryWithFactory:instance];
  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

@end

Android
iOS
在应用的 application 类的 onCreate 方法（或 FlutterActivity 的 onCreate 方法）中添加如下代码：
import android.os.Bundle;
import androidx.annotation.Nullable;
import com.tencent.effect.tencent_effect_flutter.XmagicProcesserFactory;
import io.flutter.embedding.android.FlutterActivity;
import com.tencent.trtcplugin.TRTCCloudPlugin;

public class MainActivity extends FlutterActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        TRTCCloudPlugin.register(new XmagicProcesserFactory());
    }
}
在应用的 AppDelegate 类中的 didFinishLaunchingWithOptions 方法中添加如下代码：
#import "AppDelegate.h"
#import "GeneratedPluginRegistrant.h"
@import tencent_effect_flutter;
@import tencent_trtc_cloud;
@implementation AppDelegate

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [GeneratedPluginRegistrant registerWithRegistry:self];
    XmagicProcesserFactory *instance = [[XmagicProcesserFactory alloc] init];
    [TencentTRTCCloud registerWithCustomBeautyProcesserFactory:instance];
  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

@end



2. 调用资源初始化接口

v0.3.5.0及之后
v0.3.1.1版本及之前
void _initSettings(InitXmagicCallBack callBack) async {
  String resourceDir = await ResPathManager.getResManager().getResPath();
  TXLog.printlog('$TAG method is _initResource ,xmagic resource dir is $resourceDir');
  TencentEffectApi.getApi()?.setResourcePath(resourceDir);
  /// 复制资源只需要复制一次，在当前版本中如果成功复制了一次，以后就不需要再复制资源。
  /// Copying the resource only needs to be done once. Once it has been successfully copied in the current version, there is no need to copy it again in future versions.
  if (await isCopiedRes()) {
    callBack.call(true);
    return;
  } else {
    _copyRes(callBack);
  }
}

void _copyRes(InitXmagicCallBack callBack) {
  _showDialog(context);
  TencentEffectApi.getApi()?.initXmagic((result) {
    if (result) {
      saveResCopied();
    }
    _dismissDialog(context);
    callBack.call(result);
    if (!result) {
      Fluttertoast.showToast(msg: "initialization failed");
    }
  });
}
String dir =  await BeautyDataManager.getInstance().getResDir();
 TXLog.printlog('文件路径为：$dir');
 TencentEffectApi.getApi()?.initXmagic(dir,(reslut) {
     _isInitResource = reslut;
     callBack.call(reslut);
     if (!reslut) {
         Fluttertoast.showToast(msg: "初始化资源失败");
     }
 });

3. 进行美颜授权

TencentEffectApi.getApi()?.setLicense(licenseKey, licenseUrl,
           (errorCode, msg) {
         TXLog.printlog("打印鉴权结果 errorCode = $errorCode   msg = $msg");
         if (errorCode == 0) {
            //鉴权成功
         }
       });

4. 开启/关闭美颜

注意：
美颜开启需要在相机开启之后调用，美颜关闭需要在关闭相机之前调用，开启和关闭是成对使用。
tencent_rtc_sdk
tencent_trtc_cloud
///开启美颜操作
/// 设置true 表示开启美颜，设置false 表示关闭美颜
_enableCustomBeautyByNative(bool open) {
   TencentEffectApi.getApi()?.enableBeauty(open);
}
///开启美颜操作
/// 设置true 表示开启美颜，设置false 表示关闭美颜
 var enableCustomVideo = await trtcCloud.enableCustomVideoProcess(open);

5. 设置美颜属性

v0.3.5.0及之后
v0.3.1.1版本及之前
具体美颜属性请参考 美颜属性表
TencentEffectApi.getApi()?.setEffect(sdkParam.effectName!,sdkParam.effectValue, sdkParam.resourcePath, sdkParam.extraInfo)
TencentEffectApi.getApi()?.updateProperty(_xmagicProperty!);
///_xmagicProperty 可通过 BeautyDataManager.getInstance().getAllPannelData();获取所有的属性，需要使用美颜属性的时候可通过updateProperty方法设置属性。

6. 设置其他属性

暂停美颜音效
 TencentEffectApi.getApi()?.onPause();
恢复美颜音效
TencentEffectApi.getApi()?.onResume();
监听美颜事件
TencentEffectApi.getApi()
     ?.setOnCreateXmagicApiErrorListener((errorMsg, code) {
       TXLog.printlog("创建美颜对象出现错误 errorMsg = $errorMsg , code = $code");
 });   ///需要在创建美颜之前进行设置
设置人脸、手势、身体检测状态回调
TencentEffectApi.getApi()?.setAIDataListener(XmagicAIDataListenerImp());
设置动效提示语回调函数
TencentEffectApi.getApi()?.setTipsListener(XmagicTipsListenerImp());
设置人脸点位信息等数据回调（S1-05 和 S1-06 套餐才会有回调）
TencentEffectApi.getApi()?.setYTDataListener((data) {
   TXLog.printlog("setYTDataListener  $data");
 });
移除所有回调。在页面销毁的时候需要移除掉所有的回调：
 TencentEffectApi.getApi()?.setOnCreateXmagicApiErrorListener(null);
 TencentEffectApi.getApi()?.setAIDataListener(null);
 TencentEffectApi.getApi()?.setYTDataListener(null);
 TencentEffectApi.getApi()?.setTipsListener(null);
说明：
接口详细可参考 API 文档，其他可参考 Demo 工程。

7. 添加美颜面板

美颜 SDK 默认提供了一版 UI 面板，如果您使用可以直接在代码中使用。具体使用可以参考 demo，下边为简易步骤。

7.1 设置面板使用的 JSON

 void initPanelViewConfig() {
    TEResConfig.getConfig().defaultPanelDataList.clear();
    TEResConfig.getConfig()
      ..setBeautyRes("assets/beauty_panel/beauty.json")
      ..setBeautyBodyRes("assets/beauty_panel/beauty_body.json")
      ..setLutRes("assets/beauty_panel/lut.json")
      ..setLightMakeupRes("assets/beauty_panel/light_makeup.json")
      ..setMakeUpRes("assets/beauty_panel/makeup.json")
      ..setMotionRes("assets/beauty_panel/motions.json")
      ..setSegmentationRes("assets/beauty_panel/segmentation.json");
  }

7.2 添加面板代码 TEBeautyPanelView

Expanded(
              child: TEBeautyPanelView(
                beautyPanelViewCallBack,
                null,
                beautyPanelViewCallBack.panelController,
              ),
            )

8. 配置美颜面板

面板上的属性通过 JSON 文件进行配置，JSON 文件位置如下图。可参见 JSON 文件说明。

上一篇: Android下一篇: iOS

帮助和支持

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

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

文档反馈