LottieDrawable (lottie API)

java.lang.Object
- android.graphics.drawable.Drawable
- - com.airbnb.lottie.LottieDrawable

All Implemented Interfaces:

android.graphics.drawable.Animatable, android.graphics.drawable.Drawable.Callback
```
public class LottieDrawable
extends android.graphics.drawable.Drawable
implements android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Animatable
```
This can be used to show an lottie animation in any place that would normally take a drawable.

See Also:

Full Documentation

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LottieDrawable.RepeatMode
- Nested classes/interfaces inherited from class android.graphics.drawable.Drawable
  android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LottieDrawable.RepeatMode`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`INFINITE` This value used used with the `setRepeatCount(int)` property to repeat the animation indefinitely.
`static int`	`RESTART` When the animation reaches the end and `repeatCount` is INFINITE or a positive value, the animation restarts from the beginning.
`static int`	`REVERSE` When the animation reaches the end and `repeatCount` is INFINITE or a positive value, the animation reverses direction on every iteration.

Constructor Summary

Constructors
Constructor and Description

LottieDrawable()

Constructors
Constructor and Description
`LottieDrawable()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnimatorListener(android.animation.Animator.AnimatorListener listener)`
`void`	`addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)`
`<T> void`	`addValueCallback(KeyPath keyPath, T property, LottieValueCallback<T> callback)` Add an property callback for the specified `KeyPath`.
`<T> void`	`addValueCallback(KeyPath keyPath, T property, SimpleLottieValueCallback<T> callback)` Overload of `addValueCallback(KeyPath, Object, LottieValueCallback)` that takes an interface.
`void`	`cancelAnimation()`
`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.
`void`	`endAnimation()`
`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()`
`float`	`getMaxFrame()` Returns the maximum frame set by `setMaxFrame(int)` or `setMaxProgress(float)`
`float`	`getMinFrame()` Returns the minimum frame set by `setMinFrame(int)` or `setMinProgress(float)`
`int`	`getOpacity()`
`PerformanceTracker`	`getPerformanceTracker()`
`float`	`getProgress()`
`int`	`getRepeatCount()` Defines how many times the animation should repeat.
`int`	`getRepeatMode()` Defines what this animation should do when it reaches the end.
`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()`
`boolean`	`isMergePathsEnabledForKitKatAndAbove()`
`boolean`	`isRunning()`
`void`	`loop(boolean loop)` Deprecated.
`void`	`pauseAnimation()`
`void`	`playAnimation()` Plays the animation from the beginning.
`void`	`removeAllAnimatorListeners()`
`void`	`removeAllUpdateListeners()`
`void`	`removeAnimatorListener(android.animation.Animator.AnimatorListener listener)`
`void`	`removeAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)`
`java.util.List<KeyPath>`	`resolveKeyPath(KeyPath keyPath)` Takes a `KeyPath`, potentially with wildcards or globstars and resolve it to a list of zero or more actual `Keypaths` that exist in the current animation.
`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)` Create a composition with `LottieCompositionFactory`
`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`	`setMaxFrame(java.lang.String markerName)` Sets the maximum frame to the start time + duration of the specified marker.
`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`	`setMinAndMaxFrame(java.lang.String markerName)` Sets the minimum and maximum frame to the start time and start time + duration of the specified marker.
`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`	`setMinFrame(java.lang.String markerName)` Sets the minimum frame to the start time of the specified marker.
`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`	`setRepeatCount(int count)` Sets how many times the animation should be repeated.
`void`	`setRepeatMode(int mode)` Defines what this animation should do when it reaches the end.
`void`	`setScale(float scale)` Set the scale on the current composition.
`void`	`setSpeed(float speed)` Sets the playback speed.
`void`	`setTextDelegate(TextDelegate textDelegate)`
`void`	`start()`
`void`	`stop()`
`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

- Field Detail
  - RESTART
```
public static final int RESTART
```
    When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation restarts from the beginning.
    
    See Also:
    
    Constant Field Values
  - REVERSE
```
public static final int REVERSE
```
    When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.
    
    See Also:
    
    Constant Field Values
  - INFINITE
```
public static final int INFINITE
```
    This value used used with the setRepeatCount(int) property to repeat the animation indefinitely.
    
    See Also:
    
    Constant Field Values
- 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.
  - isMergePathsEnabledForKitKatAndAbove
```
public boolean isMergePathsEnabledForKitKatAndAbove()
```
  - 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.
    Be wary if you are using many images, however. Lottie is designed to work with vector shapes from After Effects. If your images look like they could be represented with vector shapes, see if it is possible to convert them to shape layers and re-export your animation. Check the documentation at http://airbnb.io/lottie for more information about importing shapes from Sketch or Illustrator to avoid this.
  - getImageAssetsFolder
```
public java.lang.String getImageAssetsFolder()
```
  - setComposition
```
public boolean setComposition(LottieComposition composition)
```
    Create a composition with LottieCompositionFactory
    
    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
  - 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
  - start
```
public void start()
```
    Specified by:
    
    start in interface android.graphics.drawable.Animatable
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface android.graphics.drawable.Animatable
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface android.graphics.drawable.Animatable
  - 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
  - endAnimation
```
public void endAnimation()
```
  - 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.
  - getMinFrame
```
public float getMinFrame()
```
    Returns the minimum frame set by setMinFrame(int) or setMinProgress(float)
  - 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.
  - getMaxFrame
```
public float getMaxFrame()
```
    Returns the maximum frame set by setMaxFrame(int) or setMaxProgress(float)
  - setMaxProgress
```
public void setMaxProgress(float maxProgress)
```
    Sets the maximum progress that the animation will end at when playing or looping.
  - setMinFrame
```
public void setMinFrame(java.lang.String markerName)
```
    Sets the minimum frame to the start time of the specified marker.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the marker is not found.
  - setMaxFrame
```
public void setMaxFrame(java.lang.String markerName)
```
    Sets the maximum frame to the start time + duration of the specified marker.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the marker is not found.
  - setMinAndMaxFrame
```
public void setMinAndMaxFrame(java.lang.String markerName)
```
    Sets the minimum and maximum frame to the start time and start time + duration of the specified marker.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the marker is not found.
  - 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)
```
  - removeAllUpdateListeners
```
public void removeAllUpdateListeners()
```
  - addAnimatorListener
```
public void addAnimatorListener(android.animation.Animator.AnimatorListener listener)
```
  - removeAnimatorListener
```
public void removeAnimatorListener(android.animation.Animator.AnimatorListener listener)
```
  - removeAllAnimatorListeners
```
public void removeAllAnimatorListeners()
```
  - 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
```
@Deprecated
public void loop(boolean loop)
```
    Deprecated.
    
    See Also:
    
    setRepeatCount(int)
  - setRepeatMode
```
public void setRepeatMode(int mode)
```
    Defines what this animation should do when it reaches the end. This setting is applied only when the repeat count is either greater than 0 or INFINITE. Defaults to RESTART.
    
    Parameters:
    
    mode - RESTART or REVERSE
  - getRepeatMode
```
public int getRepeatMode()
```
    Defines what this animation should do when it reaches the end.
    
    Returns:
    
    either one of REVERSE or RESTART
  - setRepeatCount
```
public void setRepeatCount(int count)
```
    Sets how many times the animation should be repeated. If the repeat count is 0, the animation is never repeated. If the repeat count is greater than 0 or INFINITE, the repeat mode will be taken into account. The repeat count is 0 by default.
    
    Parameters:
    
    count - the number of times the animation should be repeated
  - getRepeatCount
```
public int getRepeatCount()
```
    Defines how many times the animation should repeat. The default value is 0.
    
    Returns:
    
    the number of times the animation should repeat, or INFINITE
  - 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.
    You can also use a fixed view width/height in conjunction with the normal ImageView scaleTypes centerCrop and centerInside.
  - 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.
    Be wary if you are using many images, however. Lottie is designed to work with vector shapes from After Effects. If your images look like they could be represented with vector shapes, see if it is possible to convert them to shape layers and re-export your animation. Check the documentation at http://airbnb.io/lottie for more information about importing shapes from Sketch or Illustrator to avoid this.
  - 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
  - resolveKeyPath
```
public java.util.List<KeyPath> resolveKeyPath(KeyPath keyPath)
```
    Takes a KeyPath, potentially with wildcards or globstars and resolve it to a list of zero or more actual Keypaths that exist in the current animation.
    If you want to set value callbacks for any of these values, it is recommend to use the returned KeyPath objects because they will be internally resolved to their content and won't trigger a tree walk of the animation contents when applied.
  - addValueCallback
```
public <T> void addValueCallback(KeyPath keyPath,
                                 T property,
                                 LottieValueCallback<T> callback)
```
    Add an property callback for the specified KeyPath. This KeyPath can resolve to multiple contents. In that case, the callbacks's value will apply to all of them.
    Internally, this will check if the KeyPath has already been resolved with resolveKeyPath(KeyPath) and will resolve it if it hasn't.
  - addValueCallback
```
public <T> void addValueCallback(KeyPath keyPath,
                                 T property,
                                 SimpleLottieValueCallback<T> callback)
```
    Overload of addValueCallback(KeyPath, Object, LottieValueCallback) that takes an interface. This allows you to use a single abstract method code block in Kotlin such as: drawable.addValueCallback(yourKeyPath, LottieProperty.COLOR) { yourColor }
  - 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

Class LottieDrawable

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class android.graphics.drawable.Drawable

Methods inherited from class java.lang.Object

Field Detail

RESTART

REVERSE

INFINITE

Constructor Detail

LottieDrawable

Method Detail

hasMasks

hasMatte

enableMergePathsForKitKatAndAbove

enableMergePathsForKitKatAndAbove

isMergePathsEnabledForKitKatAndAbove

setImagesAssetsFolder

getImageAssetsFolder

setComposition

setPerformanceTrackingEnabled

getPerformanceTracker

clearComposition

invalidateSelf

setAlpha

getAlpha

setColorFilter

getOpacity

draw

start

stop

isRunning

playAnimation

endAnimation

resumeAnimation

setMinFrame

getMinFrame

setMinProgress

setMaxFrame

getMaxFrame

setMaxProgress

setMinFrame

setMaxFrame

setMinAndMaxFrame

setMinAndMaxFrame

setMinAndMaxProgress

reverseAnimationSpeed

setSpeed

getSpeed

addAnimatorUpdateListener

removeAnimatorUpdateListener

removeAllUpdateListeners

addAnimatorListener

removeAnimatorListener

removeAllAnimatorListeners

setFrame

getFrame

setProgress

loop

setRepeatMode

getRepeatMode

setRepeatCount

getRepeatCount

isLooping

isAnimating

setScale

setImageAssetDelegate

setFontAssetDelegate

setTextDelegate

getTextDelegate

useTextGlyphs

getScale

getComposition

cancelAnimation

pauseAnimation

getProgress

getIntrinsicWidth