AvatarController.onError callback. Error types are platform-specific but cover the same categories.
Web - ErrorCode
| Code | Description | Recovery |
|---|---|---|
APP_ID_UNRECOGNIZED | The app ID is not recognized. | Verify your app ID in the dashboard. |
AVATAR_ID_UNRECOGNIZED | The avatar ID is not recognized. | Check the avatar ID exists and is published. |
SESSION_TOKEN_EXPIRED | The session token has expired. | Request a new token from your server. |
SESSION_TOKEN_INVALID | The session token is invalid. | Verify token generation on your server. |
WASM_LOAD_FAILED | Failed to load the WASM module. | Check your build tool configuration (Vite plugin / Next.js wrapper). |
WEBGL_NOT_SUPPORTED | WebGL is not supported by the browser. | Use a browser with WebGL 2.0 support. |
iOS - AvatarError
| Error | Description | Recovery |
|---|---|---|
appIDUnrecognized | The app ID is not recognized. | Verify your app ID in the dashboard. |
avatarIDUnrecognized | The avatar ID is not recognized. | Check the avatar ID exists and is published. |
avatarAssetMissing | The avatar asset is missing. | Re-download the avatar with AvatarManager.load(). |
failedToDownloadAvatarAssets | Failed to download avatar assets. | Check network connectivity and retry. |
failedToFetchAvatarMetadata | Failed to fetch avatar metadata. | Check network connectivity and retry. |
sessionTokenExpired | The session token has expired. | Request a new token from your server. |
sessionTokenInvalid | The session token is invalid. | Verify token generation on your server. |
Android - AvatarError
| Error | Description | Recovery |
|---|---|---|
AppIdUnrecognized | The app ID is not recognized. | Verify your app ID in the dashboard. |
AvatarIdUnrecognized | The avatar ID is not recognized. | Check the avatar ID exists and is published. |
AvatarAssetMissing | The avatar asset is missing. | Re-download the avatar with AvatarManager.load(). |
FailedToDownloadAvatarAssets | Failed to download avatar assets. | Check network connectivity and retry. |
FailedToFetchAvatarMetadata | Failed to fetch avatar metadata. | Check network connectivity and retry. |
SessionTokenExpired | The session token has expired. | Request a new token from your server. |
SessionTokenInvalid | The session token is invalid. | Verify token generation on your server. |
Recommended Handling Flow
- Log the SDK error code and current lifecycle phase.
- Retry transient network/download failures with backoff.
- Refresh session token for auth-related errors.
- Surface configuration errors to developers/operators.