Flutter

One Flutter dependency gives your app an avatar widget. Why on the device.

Before you start

On Android the plugin runs the same engines as the Android SDK, so the avatar renders on the phone: your app’s speech audio goes in, and a lip-synced picture comes out as a Flutter Texture.

The plugin runs on Android phones (arm64), and on iPhone, iPad and Mac (Apple silicon) after one bootstrap step that fetches the engines (Platform notes). A native iPhone or iPad app can use the Swift package instead.

Install

The plugin is published as a tag in the public homebrew-bithuman repository on GitLab. Pin it in pubspec.yaml:

dependencies:
  bithuman:
    git:
      url: https://gitlab.com/bithuman/sdk/homebrew-bithuman.git
      path: packages/flutter-plugin
      ref: flutter-plugin-v2.6.38

Then run flutter pub get. On Android, Gradle resolves ai.bithuman:essence2-android and ai.bithuman:expression2-android from the repository the plugin declares, so you add no repository yourself.

In android/app/build.gradle.kts, set the plugin’s floor and keep the engines’ native libraries as they ship:

android {
    defaultConfig {
        minSdk = 29                         // the plugin's floor, whichever model you use
        ndk { abiFilters += "arm64-v8a" }   // the engines ship arm64-v8a only
    }
    packaging { jniLibs { useLegacyPackaging = true } }   // required
}

Authenticate

The engines check your API secret when an avatar loads: pass it to BithumanAvatar.load(…, apiSecret:). For a local build, the example app asks for it on first launch and keeps it in the Android Keystore, or you pass --dart-define=BITHUMAN_API_SECRET=… when you build. A shipped app fetches the secret from your backend (What a shipped app holds).

Run your first avatar

Build the example app for your phone, with the wise-pup sample avatar:

git clone https://github.com/bithuman-product/bithuman-examples.git
cd bithuman-examples/app/avatar_chat
flutter pub get
flutter run --release --dart-define=AGENT_CODE=A23WJF0199

Expected result

The app installs on the connected phone, asks for your API secret once, downloads the avatar (about 160 MB, first run only) and shows it idling full screen. Speak, or type a line, and it answers with its lips in sync.

Performance

The plugin runs the Android SDK’s own engines (the same native libraries), so the Android rows apply: