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

Create a lip sync profile

Explains how to create a custom lip sync profile asset for a blendshape format beyond the three profiles the SDK bundles by default.

A lip sync profile defines the transport format identifier — it tells the SDK which blendshape channel names to expect from Convai.

For all standard setups, use one of the three bundled profiles and leave this page for advanced or future use.

1

Create the asset

In the Project window, navigate to the folder where you want to store the profile. Right-click and select Create > Convai > Lip Sync > Profile. Name the asset descriptively — for example, ConvaiLipSyncProfile_MyRig.

2

Configure the fields

Select the new asset to open it in the Inspector.

Field
Description

Profile ID

Transport format identifier. Must exactly match the format ID Convai streams for this character.

Display Name

Human-readable name shown in the Inspector. Does not affect runtime behavior.

Transport Format

Network transport format string — typically the same as Profile ID.

3

Assign the profile ID to the component

Set ConvaiLipSyncComponent._lockedProfileId to the Profile ID string you defined. The SDK looks up this profile from the registry at runtime.

Next steps

After creating the profile, create a map to route its channels to your rig's blendshape names.

Create a custom lip sync map

Last updated

Was this helpful?