SDK 接入
准备捏脸素材
目前我们随 SDK 提供了若干套捏脸、换装素材，素材在 SDK 解压后的 
MotionRes/avatarRes 目录中，与其他的动效素材一样，您需要把它 copy 到工程的 assets 目录：
捏脸流程与 SDK 接口
捏脸流程 | 拍照捏脸流程 |
 |  |
XMagicApi 的加载数据、捏脸、导出配置、拍照捏脸接口详情如下：
1. 加载 Avatar 素材（loadAvatar）
public void loadAvatar(XmagicProperty<?> property, UpdatePropertyListener updatePropertyListener)
Avatar 素材与普通的动效素材的加载方式是类似的，loadAvatar 接口与 SDK 的 updateProperty 接口是等价的，因此请参考 updateProperty 接口说明和 Demo 代码。
2. 加载 Avatar 源数据（getAvatarConfig）
public static Map<String,List<AvatarData>> getAvatarConfig(String avatarResPath, String savedAvatarConfigs)
输入参数：
avatarResPath：avatar 素材在手机上的绝对路径，例如
/data/data/com.tencent.pitumotiondemo.effects/files/xmagic/MotionRes/avatarRes/animoji_0624。savedAvatarConfigs：用户上次捏脸之后保存的数据，是 JSON 格式的字符串。首次使用或用户之前没有保存过的话，这个值为 null。
输出参数：
以 map 的形式返回，map 的 key 是数据的 category，详见 AvatarCategory 类，map 的 value 是这个 category 下的全部数据。应用层拿到这份 map 后，按需展示成自己想要的 UI 样式。
3. 捏脸、换装（updateAvatar）
public void updateAvatar(List<AvatarData> avatarDataList, UpdateAvatarConfigListener upDataAvatarConfigListener)
调用后实时更新当前素材的预览形象，一个 AvatarData 对象是一个原子配置（如换发型），一次可以传入多个原子配置（例如既换发型，又换发色）。该接口会检查传入 AvatarData 的有效性，有效的设置给 SDK，无效的数据会 callback 回去。
例如要求修改发型，但是头发模型文件（配置在 AvatarData 的 value 字段里）在本地找不到，就认为该 AvatarData 无效。
再例如要求修改瞳孔贴图，但是贴图文件（配置在 AvatarData 的 value 字段里）在本地找不到，就认为该 AvatarData 无效。
4. 导出捏脸配置（exportAvatar）
public static String exportAvatar(List<AvatarData> avatarDataList)
用户捏脸时，会修改 AvatarData 中的 selected 状态或形变值。捏完后，传入新的全量 AvatarData 列表，即可导出一份json字符串。这份字符串您可以存在本地，也可以上传到服务器。
导出的这份字符串有两个用途：
当下次再通过 XMagicApi 的 loadAvatar 接口加载这份 Avatar 素材时，您需要把这份 JSON 字符串设置给 XMagicProperty的customConfigs 字段，这样才能在预览中呈现出用户上次捏脸的形象。
如上文所述，调用 getAllAvatarData 时需要传入这个参数，以便修正Avatar源数据中的选中态和形变值。
5. 拍照、捏脸（createAvatarByPhoto）
该接口需要联网。
public void createAvatarByPhoto(String photoPath, List<String> avatarResPaths, boolean isMale,final FaceAttributeListener faceAttributeListener)
photoPath：照片路径，请确保人脸位于画面中间。建议画面中只包含一个人脸，如果有多个人脸，SDK会随机选择一个。建议照片的短边大于等于500px，否则可能影响识别效果。
avatarResPaths：您可以传入多套 Avatar 素材，SDK 会根据照片分析的结果，选择一套最合适的素材进行自动捏脸。
注意：
目前只支持一套，如果传入多套，SDK只会使用第一套。
isMale：是否是男性，男性设置true，女性设置false。
faceAttributeListener：如果失败，会回调
void onError(int errCode, String msg)。如果成功，会回调void onFinish(String matchedResPath, String srcData)，第一个参数是匹配到的 Avatar 素材路径，第二个参数是匹配结果，与上文中的exportAvatar 接口的返回值是一样的含义。onError 的错误码定义在
FaceAttributeHelper.java，具体如下：public static final int ERROR_NO_AUTH = 1;//没有权限public static final int ERROR_RES_INVALID = 5;//传入的Avatar素材路径无效public static final int ERROR_PHOTO_INVALID = 10;//读取照片失败public static final int ERROR_NETWORK_REQUEST_FAILED = 20;//网络请求失败public static final int ERROR_DATA_PARSE_FAILED = 30;//网络返回数据解析失败public static final int ERROR_ANALYZE_FAILED = 40;//人脸分析失败public static final int ERROR_AVATAR_SOURCE_DATA_EMPTY = 50;//加载Avatar源数据失败
6. 将下载好的配置文件放置到对应的文件夹中（addAvatarResource）
public static Pair<Integer, List<AvatarData>> addAvatarResource(String resourceRootPath, String category, String zipFilePath)
该接口主要用于动态下载Avatar配件的场景。举个例子，您的Avatar素材中有10种发型，后来想动态下发一种发型给客户端，下载完成后，得到一个压缩包，然后调用该接口，把压缩包路径传给SDK，SDK会解析这份压缩包，将它放到对应的 category 目录下。下次您在调用 getAvatarConfig 接口时，SDK就能解析出新添加的这份数据。
参数说明：
resourceRootPath：Avatar 素材的根目录，例如 /data/data/com.tencent.pitumotiondemo.effects/files/xmagic/MotionRes/avatarRes/animoji_0624
category：下载的这份配件的分类
zipFilePath：下载的 zip 包地址
接口返回
Pair<Integer, List<AvatarData>>，pair.first是错误码，pair.second是新添加的数据集合。错误码如下：
public interface AvatarActionErrorCode {int OK = 0;int ADD_AVATAR_RES_INVALID_PARAMS = 1000;int ADD_AVATAR_RES_ROOT_RESOURCE_NOT_EXIST = 1001;int ADD_AVATAR_RES_ZIP_FILE_NOT_EXIST = 1002;int ADD_AVATAR_RES_UNZIP_FILE_FAILED = 1003;int ADD_AVATAR_RES_COPY_FILE_FAILED = 1004;}
7. 调用 AvatarData
上述接口的核心都是 AvatarData 类，其主要内容如下：
public class AvatarData {/*** 选择型数据。例如眼镜，有很多种眼镜，使用时只能从中选择一个。*/public static final int TYPE_SELECTOR = 0;/*** 滑竿调节型数据。例如调整脸颊宽度。*/public static final int TYPE_SLIDER = 1;//例如 脸型、眼睛微调 等。AvatarCategory.java中定义了标准的category，如果不满足需求，也可以自定义category字符串，跟已有的不冲突即可//不能为空。public String category;//标识每一个具体item 或者 每一组微调项。//例如每个眼镜都有自己的id。每一组微调项也有自己的id。//不能为空。public String id;//TYPE_SELECTOR 或者 TYPE_SLIDERpublic int type;//如果是selector类型，则它表示当前有无被选中public boolean selected = false;//每一个图标 或 每一组微调项 背后都对应着具体的配置详情，即下面这三要素。public String entityName;public String action;public JsonObject value;}
一个 AvatarData 对象是一个原子配置，如换发型、调整脸颊等：
换发型 | 调整脸颊 |
 |  |
捏脸时，如果数据是 selector 类型，则修改 AvatarData 的 selected 字段。例如有4种眼镜 A、B、C、D，默认选中的是 A，那么 A 的 selected 为 true，B、C、D 为 false。如果用户选择了眼镜 B，则把 B 的 selected 为 true，A、C、D 为false。
捏脸时，如果数据是 slider 类型，则修改 AvatarData 的 value 字段。value 字段是一个 JsonObject，里面是若干对 key-value，把 key-value 中的 value 修改为滑竿的值即可。
8. 获取Avatar动画数据（getAvatarAnimations）
public static List<AvatarAnimation> getAvatarAnimations(String avatarResPath)
输入参数：avatarResPath
avatar 素材在手机上的绝对路径，例如
/data/data/com.tencent.pitumotiondemo.effects/files/xmagic/MotionRes/avatarRes/animoji_0624输出参数：以 List 的形式返回所有的动画资源数据，详情可见AvatarAnimation类。
9. 将下载好的动画配文件放置到对应的文件夹中（addAvatarAnimation）
public static Pair<Integer, List<AvatarAnimation>> addAvatarAnimation(String avatarResPath, String zipFilePath)
该接口主要用于动态下载Avatar动画配件的场景。举个例子，您的Avatar素材中有1种动画，后来想动态下发一种动画给客户端，下载完成后，得到一个压缩包，然后调用该接口，把压缩包路径传给SDK，SDK会解析这份压缩包，将它放到对应的动画资源目录下。下次您在调用 getAvatarAnimations 接口时，SDK就能解析出新添加的这份数据。
参数说明：
avatarResPath：Avatar 素材的根目录，例如 /data/data/com.tencent.pitumotiondemo.effects/files/xmagic/MotionRes/avatarRes/animoji_0624
zipFilePath：下载的 zip 包地址
接口返回
Pair<Integer, List<AvatarAnimation>>，pair.first是错误码，pair.second是新添加的数据集合。错误码如下：
public interface AvatarActionErrorCode {int OK = 0;int ADD_AVATAR_RES_INVALID_PARAMS = 1000;int ADD_AVATAR_RES_ROOT_RESOURCE_NOT_EXIST = 1001;int ADD_AVATAR_RES_ZIP_FILE_NOT_EXIST = 1002;int ADD_AVATAR_RES_UNZIP_FILE_FAILED = 1003;int ADD_AVATAR_RES_COPY_FILE_FAILED = 1004;int ADD_AVATAR_RES_PARSE_JSON_FILE_FAILED = 1005;}
10. 播放/暂停 Avatar动画（playAvatarAnimation）
public void playAvatarAnimation(AnimationPlayConfig animationConfig)
输入参数：
AnimationPlayConfig：动画播放信息描述类。此类主要包含一下信息
public class AnimationPlayConfig {//action 描述，播放还是停止 动画public static final String ACTION_PLAY = "play";public static final String ACTION_PAUSE = "pause";public static final String ACTION_RESUME = "resume";public static final String ACTION_STOP = "stop";public String entityName;/** * 动画文件夹的路径，可以是相对于素材根目录的相对路径（例如 custom_configs/animations/Waving")/** 也可以是在手机上的绝对路径（例如 /data/data/xxx/xxx/Waving) */public String animPath;//值使用 ACTION_PLAY、ACTION_PAUSE、ACTION_RESUME、ACTION_STOPpublic String action;/** * 动画的名称 */public String animName;/** * 循环次数，-1表示无限 */public int loopCount = -1;/** * 动画的起始播放位置，单位是微秒 */public long startPositionUs = 0;}
AvatarData 高级说明
AvatarData 中，对捏脸起关键作用的是 entityName、action、value 三个字段。这三个字段的值是 SDK 在解析素材配置时自动填入的。大多数情况下，您不需要了解这三个字段的含义，仅在 UI 层展示时，如果是滑竿类型，则需要解析 value 中的形变 key-value 与 UI 操作进行对应。
其中，AvatarData 要素分为：entityName、action 和 value 字段
entityName 字段
捏脸时，需要明确指定捏哪个部位，例如脸、眼睛、头发、上衣、鞋子 等等。entityName 字段就是描述这些身体部位名称的。
action 和 value 字段
action 字段表示对 entityName 执行什么操作（action）。SDK 内定义了五种 action，均定义在
AvatarAction.java中，每种 action 的含义及 value 要求如下：action | 含义 | value要求 |
changeColor | 修改当前材质的颜色，包括基础色、自发光色等颜色属性 | JsonObject 类型，必填。由素材制作工具自动生成。 |
changeTexture | 修改当前材质的贴图，包括颜色纹理贴图、金属粗糙度纹理贴图、AO 纹理贴图、法线纹理贴图、自发光纹理贴图等等 | JsonObject 类型。必填。由素材制作工具自动生成。 |
shapeValue | 修改blendShape形变值，一般用于面部细节形变微调 | JsonObject 类型。里面的 key 是形变名称，value 是float 类型的值。必填。由素材制作工具自动生成。 |
replace | 替换子模型，例如替换眼镜、发型、衣服等 | JsonObject 类型。里面描述了新的子模型的3D变换信息、模型路径、材质路径。如果要隐藏当前位置的子模型，则使用 null。由素材制作工具自动生成。 |
basicTransform | 调整位置、旋转、缩放。一般用于调整摄像机的远近、角度，从而实现模型全身和半身视角的切换 | JsonObject 类型。必填。由素材制作工具自动生成。 |
配置 Avatar 捏脸换装数据
avatar 属性配置存放在 resources 文件夹下（路径为：
素材/custom_configs/resources）：
这些配置文件是自动生成的，通常不需要手动配置。自动生成的方式如下：
设计师按照设计规范，用TencentEffectStudio设计好一套形象后，运行我们提供的 resource_generator_gui 这个 App（目前仅支持 MacOS 平台），即可自动生成这些配置，详情请参见 设计规范说明。
是
否
本页内容是否解决了您的问题？