SPAvatarKit Flutter Plugin #

A Flutter plugin for displaying digital characters using SPAvatarKit SDK with real-time rendering, audio-driven animations, and network connectivity.

Features #

• Display digital characters with real-time rendering
• Load characters with specific IDs
• Connect to network services for character interaction
• Play audio files to drive character animations
• Real-time state monitoring and control
• Optimized for production use (device only)

Requirements #

• iOS 18.0+ / Android API 21+
• Flutter 3.3.0+
• Dart SDK ^3.8.1
• SPAvatarKit SDK license

Note: This is the production version optimized for physical devices. For development and testing with iOS simulator, please use the sp_character_plugin_dev package.

Installation #

Add this dependency to your pubspec.yaml:

dependencies:
  sp_character_plugin: ^1.0.0-beta.2

Usage #

import 'package:sp_character_plugin/character_widget.dart';

// Create a character widget
CharacterWidget.createWithController(
  sessionToken: "your_session_token",
  setUpStateChanged: (state) {
    // Handle setup state changes
  },
  loadStateChanged: (state, progress) {
    // Handle load state changes
  },
  connectionStateChanged: (state) {
    // Handle connection state changes
  },
  // ... other callbacks
)

Example App #

The plugin includes a comprehensive example app in the example/ directory that demonstrates:

• Character loading and display
• Network connection management
• Audio playback for character animation
• Real-time state monitoring

To run the example (iOS device only):

cd example
flutter pub get
flutter run

Platform Support #

• iOS: Full support for physical devices (iOS 18.0+)
• Android: Coming soon
• Web: Coming soon

Important: This production version does not support iOS Simulator. For simulator support, use the development version.

Production vs Development #

This production version (sp_character_plugin) is optimized for:

• Production applications
• Physical iOS devices
• Smaller package size
• Better performance

For development and testing with iOS simulator, use:

dependencies:
  sp_character_plugin_dev: ^1.0.0-beta.2-dev

License #

This plugin is licensed under the MIT License. See the LICENSE file for details.