Render After Effects animations natively on Flutter. This package is a pure Dart implementation of a Lottie player.
Add support for layer blend mode
Allow to load Telegram Stickers (.tgs)
Lottie.asset(
'sticker.tgs',
decoder: LottieComposition.decodeGZip,
)
renderCache
parameter.Lottie.asset('assets/complex_animation.json',
renderCache: RenderCache.raster,
)
Opt-in to a special render mode where the frames of the animation are lazily rendered and kept in a cache.
Subsequent runs of the animation are cheaper to render.
There are 2 kinds of caches:
RenderCache.raster: keep the frame rasterized in the cache (as [dart:ui.Image]).
Subsequent runs of the animation are very cheap for both the CPU and GPU but it takes
a lot of memory.
RenderCache.drawingCommands: keep the frame as a list of graphical operations ([dart:ui.Picture]).
Subsequent runs of the animation are cheaper for the CPU but not for the GPU.
Lottie.asset(
'animation.lottie',
decoder: customDecoder,
);
Future<LottieComposition?> customDecoder(List<int> bytes) {
return LottieComposition.decodeZip(bytes, filePicker: (files) {
return files.firstWhere((f) => f.name == 'animations/cat.json');
});
}
Add backgroundLoading
parameter to Lottie.asset|network|file|memory
.
If backgroundLoading
is true, the animation will be loaded in a background isolate.
This is useful for large animations that can take a long time to parse and block the UI work.
Remove the name property from LottieComposition
imageProviderFactory
is not used in .zip file by default anymore.
To restore the old behaviour, use:
Future<LottieComposition?> decoder(List<int> bytes) {
return LottieComposition.decodeZip(bytes, imageProviderFactory: imageProviderFactory);
}
Lottie.asset('anim.json', decoder: decoder)
ValueDelegate.gradientColor
is usedDefaultAssetBundle.of
in AssetLottie
before fallback to rootBundle
BuildContext
optional parameter in LottieProvider.load
Add backgroundLoading
parameter to Lottie.asset|network|file|memory
.
If backgroundLoading
is true, the animation will be loaded in a background isolate.
This is useful for large animations that can take a long time to parse and block the UI work.
Replace enableRenderCache
with renderCache: RenderCache.raster
.
The new class RenderCache
allows to specify the cache behaviour:
RenderCache.raster
: Cache the frames as rasterized images living in the GPU memory.RenderCache.drawingCommands
: Cache the frames as a list of graphical operations. This will only save CPU
work but will use a lot less memory.enableRenderCache
(now limited to 50MB)Lottie.renderCacheMaxMemory = 75000000;
enableRenderCache
parameter.Lottie.asset('assets/complex_animation.json',
enableRenderCache: true,
)
It allows to opt into a mode where the frames of the animation are rendered lazily in an offscreen cache. Subsequent runs of the animation will be very cheap to render.
This is useful is the animation is complex and can consume a lot of energy from the battery. It's a trade-off to lower the CPU usage at the cost of an increased memory usage.
The render cache is managed internally and will release the memory once the animation is disposed.
The cache is shared between all animations. If 2 Lottie
widget are rendered at the same size, they will render only
once.
Any change in the configuration of the animation (delegates, frame rate etc...) will clear the cache. Any change in the size will invalidate the cache. The cache use the final size visible on the screen (with all transforms applied).
Lottie.asset(
'sticker.tgs',
decoder: LottieComposition.decodeGZip,
)
Lottie.asset(
'animation.lottie',
decoder: customDecoder,
);
Future<LottieComposition?> customDecoder(List<int> bytes) {
return LottieComposition.decodeZip(bytes, filePicker: (files) {
return files.firstWhere((f) => f.name == 'animations/cat.json');
});
}
LottieComposition
imageProviderFactory
is not used in .zip file by default anymore.
To restore the old behaviour, use:Future<LottieComposition?> decoder(List<int> bytes) {
return LottieComposition.decodeZip(bytes, imageProviderFactory: imageProviderFactory);
}
Lottie.asset('anim.json', imageProviderFactory: imageProviderFactory, decoder: decoder)
ValueDelegate.gradientColor
is usedDefaultAssetBundle.of
in AssetLottie
before fallback to rootBundle
BuildContext
optional parameter in LottieProvider.load
List<int>
instead of Uint8List
in LottieComposition.fromBytes