API Reference

static Future<String> appID()

static Future<Configuration> configuration()

static Future<String> sessionToken()

static Future<void> setSessionToken(String sessionToken)

static Future<String> userID()

static Future<void> setUserID(String userID)

static Future<bool> supportsCurrentDevice()

static Future<String> version()

static Future<void> initialize({required String appID, required Configuration configuration})

static Future<int> benchmark()

static final AvatarManager shared

Future<Avatar> load({required String id, void Function(double progress)? onProgress})

Future<Avatar?> retrieve({required String id})

Future<Avatar> derive(String assetPath)

Future<void> clear({required String id})

Future<void> clearAll()

Future<int> getCacheSize({required String id})

Future<int> getAllCacheSize()

void Function()? onFirstRendering

void Function(ConnectionState state, String? errorMessage)? onConnectionState

void Function(ConversationState state)? onConversationState

void Function(AvatarError error)? onError

Future<void> start()

Future<void> close()

Future<void> interrupt()

Future<String> send(Uint8List audioData, {bool end = false})

Future<String> yieldAudioData(Uint8List audioData, {bool end = false, AudioFormat? audioFormat})

Future<void> yieldAnimations(List<Uint8List> animations, {required String conversationID})

Future<int> pointCount()

Future<double> volume()

Future<void> setVolume(double volume)

Future<bool> isOpaque()

Future<void> setOpaque(bool opaque)

Future<Transform> contentTransform()

Future<void> setContentTransform(Transform transform)

const AvatarWidget({
  Key? key,
  required Avatar avatar,
  required void Function(AvatarController controller) onPlatformViewCreated,
})

const Configuration({
  required Environment environment,
  AudioFormat audioFormat = const AudioFormat(),
  DrivingServiceMode drivingServiceMode = DrivingServiceMode.sdk,
  LogLevel logLevel = LogLevel.off,
})

const AudioFormat({int sampleRate = 16000})

const Transform({double x = 0.0, double y = 0.0, double scale = 1.0})