For the complete documentation index, see llms.txt. This page is also available as Markdown.

创建配置文件

在 Unity 中创建并注册自定义口型同步配置文件,了解配置文件字段,并为您的项目配置受支持的传输格式。

简介

A 口型同步配置文件 定义角色设置在口型同步系统中所使用的通道架构。在大多数情况下,内置配置文件已经足够。不过,您也可以创建自定义配置文件资源,以更好地组织项目、使用项目特定的标识符,或覆盖受支持的传输格式在编辑器工作流中的表示方式。

本页将解释配置文件检查器、配置文件注册表,以及如何正确创建自定义配置文件。


开始之前

目前,Convai 仅支持以下传输格式:

传输格式
支持的架构

arkit

ARKit

mha

MetaHuman

cc4_extended

CC4 扩展

这一点很重要,因为创建新的配置文件资源并不会 不是 创建新的传输格式。

自定义配置文件可以帮助您:

  • 重命名或重新组织受支持的架构

  • 为您的项目使用自定义配置文件 ID

  • 将该自定义配置文件指向一种受支持的格式

自定义配置文件不能用于引入一个完全新的、超出范围的传输值 arkit, mha,或 cc4_extended.


理解配置文件检查器

当您选择一个 ConvaiLipSyncProfileAsset时,检查器会分为三个主要区域。

运行时标识

此部分控制该配置文件在内部如何被标识。

配置文件 ID 一个在运行时用于标识该配置文件的唯一规范化字符串。

此 ID 用于:

  • 配置文件目录查找

  • 映射目标定位

  • 注册表合并

  • 组件配置

请谨慎选择。一旦其他资源引用了此 ID,修改它可能会破坏这些引用。

编辑器标签

显示名称 这是在下拉菜单和编辑器工具中显示的人类可读标签。

它不会直接影响运行时行为,但对可用性很重要。请使用团队成员能立即识别的清晰名称。

传输格式

此部分决定该配置文件解析为哪种受支持的传输格式。

覆盖默认标记 禁用时,配置文件使用其自身的 配置文件 ID 作为传输标记。

启用时,配置文件可以使用不同的受支持传输标记。当您想要自定义内部配置文件 ID,但仍需要该配置文件解析为内置受支持格式之一时,这很有用。

传输标记 传输标记必须是当前受支持的值之一:

  • arkit

  • mha

  • cc4_extended

例如,一个 ID 为 my_metahuman_variant 的配置文件仍然可以使用 mha 传输标记。


创建自定义配置文件

1

创建配置文件资源

在 Unity 项目窗口中,创建一个新的配置文件资源:

给它起一个具有描述性的名称,例如:

2

设置配置文件 ID

运行时标识 部分,输入一个唯一 ID。

例如:

使用小写字母、数字和下划线。避免使用空格。

3

设置显示名称

编辑器标签 部分,输入应在检查器中显示的名称。

例如:

4

设置传输格式

选择此配置文件应使用哪一种受支持的口型同步架构。

例如:

  • 使用 arkit 用于兼容 ARKit 的混合形状布局

  • 使用 mha 用于 MetaHuman 绑定

  • 使用 cc4_extended 用于 CC4 扩展绑定

如果您的自定义配置文件 ID 与这些受支持标记都不匹配,请启用 覆盖默认标记 并手动输入正确的受支持传输标记。


理解配置文件注册表

配置文件通过 配置文件注册表 资源被发现。

注册表是一个 ConvaiLipSyncProfileRegistryAsset ,其中包含一个或多个配置文件引用,以及在运行时合并时使用的优先级值。

注册表字段

字段
说明

优先级

决定加载和覆盖顺序

配置文件

注册表中包含的配置文件资源列表

内置注册表使用优先级 0。您自己的自定义注册表应使用更高的值,例如 1,这样它会在内置集合之后合并。

注册配置文件

1

创建配置文件注册表

在项目窗口中创建一个注册表资源:

给它起一个名称,例如:

2

设置注册表优先级

设置 优先级 为高于内置注册表的值。

建议起始值:

3

将配置文件添加到注册表

将您的新 ConvaiLipSyncProfileAsset 添加到 配置文件 列表中。

4

将注册表放在正确的 Resources 路径中

要让 SDK 自动发现它,注册表必须放在以下路径下:

一旦资源保存在那里,Unity 会在下一次域重载或播放模式刷新时将其包含进来。

运行时发现的工作方式

当口型同步配置文件目录初始化时,它会:

  1. 加载内置注册表

  2. 扫描以下路径下的其他注册表: Resources/LipSync/ProfileRegistries/

  3. 按优先级排序

  4. 将所有发现的配置文件合并为一个运行时目录

如果两个注册表定义了相同的 配置文件 ID,则优先级更高的定义会替换优先级更低的定义,并记录一条警告。


重要限制

创建自定义配置文件时,请记住以下几点:

配置文件 ID 应视为永久不变

一旦配置文件被映射、注册表或组件引用,修改 ID 可能会静默破坏这些引用。

传输格式是固定的

仅支持以下传输格式:

  • arkit

  • mha

  • cc4_extended

输入一个完全自定义的值并不会为新格式添加支持。

注册表优先级会影响替换行为

如果两个注册表定义了相同的配置文件 ID,则优先级更高的定义会替换较早的定义。重复 ID 之间不会合并。


下一步

在创建并注册配置文件后,下一步是创建或分配一个指向它的映射。

继续阅读 创建自定义映射 以定义该配置文件如何驱动角色的实际混合形状。

结论

自定义配置文件主要用于在项目中组织和标识受支持的口型同步架构。它让您在命名和项目结构上更灵活,同时仍保持在当前受支持的传输格式范围内。

如果您的角色需要到网格混合形状的自定义路由,请接下来创建一个映射。

需要帮助? 如有疑问,请访问 Convai 开发者论坛.

最后更新于

这有帮助吗?