Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spatius.ai/llms.txt

Use this file to discover all available pages before exploring further.

This quickstart targets the Direct Mode path in a Flutter app. The sample runs on iOS and Android and uses the spatius Flutter package.

​
Prerequisites

  • Flutter 3.10.0+ and Dart 3.0.0+
  • iOS 16+ or Android API 24+
  • App ID, Avatar ID, and Session Token from Spatius Studio
  • A physical device is recommended for audio and rendering validation

​
Run the demo

git clone https://github.com/spatius-ai/spatius-avatar-demo.git
cd spatius-avatar-demo/direct-mode/clients/flutter
Install dependencies: 
flutter pub get
For iOS, install pods first: 
cd ios
pod install
cd ..
flutter run
For Android: 
flutter run

​
Configure the app

In the configuration screen:
  1. Enter your App ID.
  2. Enter a valid Session Token.
  3. Select the us-west region.
  4. Tap Initialize SDK.
  5. Choose an avatar and tap Start.
  6. Send one of the bundled PCM files to validate avatar playback.

​
What this proves

  • The Flutter package installs successfully.
  • AvatarKit initializes on iOS or Android through Flutter.
  • The app can load an avatar by Avatar ID.
  • The app can start a Direct Mode connection with a Session Token.
  • PCM avatar speech audio drives local rendering.

​
Next steps

Flutter SDK reference

Package install, initialization, and core API shape.

Browse all demos

All Direct Mode demos, including Web, iOS, Android, and Flutter.