com.airbnb.lottie

Class LottieDrawable

java.lang.Object

android.graphics.drawable.Drawable

com.airbnb.lottie.LottieDrawable

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback

public class LottieDrawable
extends android.graphics.drawable.Drawable
implements android.graphics.drawable.Drawable.Callback

This can be used to show an lottie animation in any place that would normally take a drawable. If there are masks or mattes, then you MUST call recycleBitmaps() when you are done or else you will leak bitmaps.

It is preferable to use LottieAnimationView when possible because it handles bitmap recycling and asynchronous loading of compositions.

Nested Class Summary

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Constructor Summary

Constructors

Constructor and Description
LottieDrawable()

Method Summary

Modifier and Type	Method and Description
void	addAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	addColorFilter(android.graphics.ColorFilter colorFilter) Add a color filter to all layers
void	addColorFilterToContent(java.lang.String layerName, java.lang.String contentName, android.graphics.ColorFilter colorFilter) Add a color filter to specific content on a specific layer.
void	addColorFilterToLayer(java.lang.String layerName, android.graphics.ColorFilter colorFilter) Add a color filter to a whole layer
void	cancelAnimation()
void	clearColorFilters() Clear all color filters on all layers and all content in the layers
void	clearComposition()
void	draw(android.graphics.Canvas canvas)
boolean	enableMergePathsForKitKatAndAbove()
void	enableMergePathsForKitKatAndAbove(boolean enable) Enable this to get merge path support for devices running KitKat (19) and above.
int	getAlpha()
LottieComposition	getComposition()
int	getFrame() Get the currently rendered frame.
android.graphics.Bitmap	getImageAsset(java.lang.String id)
java.lang.String	getImageAssetsFolder()
int	getIntrinsicHeight()
int	getIntrinsicWidth()
int	getOpacity()
PerformanceTracker	getPerformanceTracker()
float	getProgress()
float	getScale()
float	getSpeed() Returns the current playback speed.
TextDelegate	getTextDelegate()
android.graphics.Typeface	getTypeface(java.lang.String fontFamily, java.lang.String style)
boolean	hasMasks() Returns whether or not any layers in this composition has masks.
boolean	hasMatte() Returns whether or not any layers in this composition has a matte layer.
void	invalidateDrawable(android.graphics.drawable.Drawable who) These Drawable.Callback methods proxy the calls so that this is the drawable that is actually invalidated, not a child one which will not pass the view's validateDrawable check.
void	invalidateSelf()
boolean	isAnimating()
boolean	isLooping()
void	loop(boolean loop)
void	pauseAnimation()
void	playAnimation() Plays the animation from the beginning.
void	recycleBitmaps() If you have image assets and use LottieDrawable directly, you must call this yourself.
void	removeAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	removeAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	resumeAnimation() Continues playing the animation from its current position.
void	reverseAnimationSpeed() Reverses the current animation speed.
void	scheduleDrawable(android.graphics.drawable.Drawable who, java.lang.Runnable what, long when)
void	setAlpha(int alpha)
void	setColorFilter(android.graphics.ColorFilter colorFilter)
boolean	setComposition(LottieComposition composition)
void	setFontAssetDelegate(FontAssetDelegate assetDelegate) Use this to manually set fonts.
void	setFrame(int frame) Sets the progress to the specified frame.
void	setImageAssetDelegate(ImageAssetDelegate assetDelegate) Use this if you can't bundle images with your app.
void	setImagesAssetsFolder(java.lang.String imageAssetsFolder) If you use image assets, you must explicitly specify the folder in assets/ in which they are located because bodymovin uses the name filenames across all compositions (img_#).
void	setMaxFrame(int maxFrame) Sets the maximum frame that the animation will end at when playing or looping.
void	setMaxProgress(float maxProgress) Sets the maximum progress that the animation will end at when playing or looping.
void	setMinAndMaxFrame(int minFrame, int maxFrame)
void	setMinAndMaxProgress(float minProgress, float maxProgress)
void	setMinFrame(int minFrame) Sets the minimum frame that the animation will start from when playing or looping.
void	setMinProgress(float minProgress) Sets the minimum progress that the animation will start from when playing or looping.
void	setPerformanceTrackingEnabled(boolean enabled)
void	setProgress(float progress)
void	setScale(float scale) Set the scale on the current composition.
void	setSpeed(float speed) Sets the playback speed.
void	setTextDelegate(TextDelegate textDelegate)
void	unscheduleDrawable(android.graphics.drawable.Drawable who, java.lang.Runnable what)
android.graphics.Bitmap	updateBitmap(java.lang.String id, android.graphics.Bitmap bitmap) Allows you to modify or clear a bitmap that was loaded for an image either automatically through setImagesAssetsFolder(String) or with an ImageAssetDelegate.
boolean	useTextGlyphs()

Methods inherited from class android.graphics.drawable.Drawable

applyTheme, canApplyTheme, clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getChangingConfigurations, getColorFilter, getConstantState, getCurrent, getDirtyBounds, getHotspotBounds, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getOutline, getPadding, getState, getTransparentRegion, inflate, inflate, isAutoMirrored, isFilterBitmap, isStateful, isVisible, jumpToCurrentState, mutate, onBoundsChange, onLayoutDirectionChanged, onLevelChange, onStateChange, resolveOpacity, scheduleSelf, setAutoMirrored, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setLayoutDirection, setLevel, setState, setTint, setTintList, setTintMode, setVisible, unscheduleSelf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LottieDrawable

public LottieDrawable()

Method Detail

hasMasks

public boolean hasMasks()

Returns whether or not any layers in this composition has masks.

hasMatte

public boolean hasMatte()

Returns whether or not any layers in this composition has a matte layer.

enableMergePathsForKitKatAndAbove

public boolean enableMergePathsForKitKatAndAbove()

enableMergePathsForKitKatAndAbove

public void enableMergePathsForKitKatAndAbove(boolean enable)

Enable this to get merge path support for devices running KitKat (19) and above. Merge paths currently don't work if the the operand shape is entirely contained within the first shape. If you need to cut out one shape from another shape, use an even-odd fill type instead of using merge paths.

setImagesAssetsFolder

public void setImagesAssetsFolder(java.lang.String imageAssetsFolder)

If you use image assets, you must explicitly specify the folder in assets/ in which they are located because bodymovin uses the name filenames across all compositions (img_#). Do NOT rename the images themselves. If your images are located in src/main/assets/airbnb_loader/ then call `setImageAssetsFolder("airbnb_loader/");`. If you use LottieDrawable directly, you MUST call recycleBitmaps() when you are done. Calling recycleBitmaps() doesn't have to be final and LottieDrawable will recreate the bitmaps if needed but they will leak if you don't recycle them.

getImageAssetsFolder

public java.lang.String getImageAssetsFolder()

recycleBitmaps

public void recycleBitmaps()

If you have image assets and use LottieDrawable directly, you must call this yourself. Calling recycleBitmaps() doesn't have to be final and LottieDrawable will recreate the bitmaps if needed but they will leak if you don't recycle them.

setComposition

public boolean setComposition(LottieComposition composition)

Returns:

True if the composition is different from the previously set composition, false otherwise.

setPerformanceTrackingEnabled

public void setPerformanceTrackingEnabled(boolean enabled)

getPerformanceTracker

public PerformanceTracker getPerformanceTracker()

clearComposition

public void clearComposition()

invalidateSelf

public void invalidateSelf()

Overrides:

invalidateSelf in class android.graphics.drawable.Drawable

setAlpha

public void setAlpha(int alpha)

Specified by:

setAlpha in class android.graphics.drawable.Drawable

getAlpha

public int getAlpha()

Overrides:

getAlpha in class android.graphics.drawable.Drawable

setColorFilter

public void setColorFilter(android.graphics.ColorFilter colorFilter)

Specified by:

setColorFilter in class android.graphics.drawable.Drawable

addColorFilterToContent

public void addColorFilterToContent(java.lang.String layerName,
                                    java.lang.String contentName,
                                    android.graphics.ColorFilter colorFilter)

Add a color filter to specific content on a specific layer.

Parameters:

layerName - name of the layer where the supplied content name lives

contentName - name of the specific content that the color filter is to be applied

colorFilter - the color filter, null to clear the color filter

addColorFilterToLayer

public void addColorFilterToLayer(java.lang.String layerName,
                                  android.graphics.ColorFilter colorFilter)

Add a color filter to a whole layer

Parameters:

layerName - name of the layer that the color filter is to be applied

colorFilter - the color filter, null to clear the color filter

addColorFilter

public void addColorFilter(android.graphics.ColorFilter colorFilter)

Add a color filter to all layers

Parameters:

colorFilter - the color filter, null to clear all color filters

clearColorFilters

public void clearColorFilters()

Clear all color filters on all layers and all content in the layers

getOpacity

public int getOpacity()

Specified by:

getOpacity in class android.graphics.drawable.Drawable

draw

public void draw(android.graphics.Canvas canvas)

Specified by:

draw in class android.graphics.drawable.Drawable

playAnimation

public void playAnimation()

Plays the animation from the beginning. If speed is < 0, it will start at the end and play towards the beginning

resumeAnimation

public void resumeAnimation()

Continues playing the animation from its current position. If speed < 0, it will play backwards from the current position.

setMinFrame

public void setMinFrame(int minFrame)

Sets the minimum frame that the animation will start from when playing or looping.

setMinProgress

public void setMinProgress(float minProgress)

Sets the minimum progress that the animation will start from when playing or looping.

setMaxFrame

public void setMaxFrame(int maxFrame)

Sets the maximum frame that the animation will end at when playing or looping.

setMaxProgress

public void setMaxProgress(float maxProgress)

Sets the maximum progress that the animation will end at when playing or looping.

setMinAndMaxFrame

public void setMinAndMaxFrame(int minFrame,
                              int maxFrame)

See Also:

setMinFrame(int), setMaxFrame(int)

setMinAndMaxProgress

public void setMinAndMaxProgress(float minProgress,
                                 float maxProgress)

See Also:

setMinProgress(float), setMaxProgress(float)

reverseAnimationSpeed

public void reverseAnimationSpeed()

Reverses the current animation speed. This does NOT play the animation.

See Also:

setSpeed(float), playAnimation(), resumeAnimation()

setSpeed

public void setSpeed(float speed)

Sets the playback speed. If speed < 0, the animation will play backwards.

getSpeed

public float getSpeed()

Returns the current playback speed. This will be < 0 if the animation is playing backwards.

addAnimatorUpdateListener

public void addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)

removeAnimatorUpdateListener

public void removeAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)

addAnimatorListener

public void addAnimatorListener(android.animation.Animator.AnimatorListener listener)

removeAnimatorListener

public void removeAnimatorListener(android.animation.Animator.AnimatorListener listener)

setFrame

public void setFrame(int frame)

Sets the progress to the specified frame. If the composition isn't set yet, the progress will be set to the frame when it is.

getFrame

public int getFrame()

Get the currently rendered frame.

setProgress

public void setProgress(float progress)

loop

public void loop(boolean loop)

isLooping

public boolean isLooping()

isAnimating

public boolean isAnimating()

setScale

public void setScale(float scale)

Set the scale on the current composition. The only cost of this function is re-rendering the current frame so you may call it frequent to scale something up or down. The smaller the animation is, the better the performance will be. You may find that scaling an animation down then rendering it in a larger ImageView and letting ImageView scale it back up with a scaleType such as centerInside will yield better performance with little perceivable quality loss.

setImageAssetDelegate

public void setImageAssetDelegate(ImageAssetDelegate assetDelegate)

Use this if you can't bundle images with your app. This may be useful if you download the animations from the network or have the images saved to an SD Card. In that case, Lottie will defer the loading of the bitmap to this delegate.

setFontAssetDelegate

public void setFontAssetDelegate(FontAssetDelegate assetDelegate)

Use this to manually set fonts.

setTextDelegate

public void setTextDelegate(TextDelegate textDelegate)

getTextDelegate

public TextDelegate getTextDelegate()

useTextGlyphs

public boolean useTextGlyphs()

getScale

public float getScale()

getComposition

public LottieComposition getComposition()

cancelAnimation

public void cancelAnimation()

pauseAnimation

public void pauseAnimation()

getProgress

public float getProgress()

getIntrinsicWidth

public int getIntrinsicWidth()

Overrides:

getIntrinsicWidth in class android.graphics.drawable.Drawable

getIntrinsicHeight

public int getIntrinsicHeight()

Overrides:

getIntrinsicHeight in class android.graphics.drawable.Drawable

updateBitmap

public android.graphics.Bitmap updateBitmap(java.lang.String id,
                                            android.graphics.Bitmap bitmap)

Allows you to modify or clear a bitmap that was loaded for an image either automatically through setImagesAssetsFolder(String) or with an ImageAssetDelegate.

Returns:

the previous Bitmap or null.

getImageAsset

public android.graphics.Bitmap getImageAsset(java.lang.String id)

getTypeface

public android.graphics.Typeface getTypeface(java.lang.String fontFamily,
                                             java.lang.String style)

invalidateDrawable

public void invalidateDrawable(android.graphics.drawable.Drawable who)

These Drawable.Callback methods proxy the calls so that this is the drawable that is actually invalidated, not a child one which will not pass the view's validateDrawable check.

Specified by:

invalidateDrawable in interface android.graphics.drawable.Drawable.Callback

scheduleDrawable

public void scheduleDrawable(android.graphics.drawable.Drawable who,
                             java.lang.Runnable what,
                             long when)

Specified by:

scheduleDrawable in interface android.graphics.drawable.Drawable.Callback

unscheduleDrawable

public void unscheduleDrawable(android.graphics.drawable.Drawable who,
                               java.lang.Runnable what)

Specified by:

unscheduleDrawable in interface android.graphics.drawable.Drawable.Callback