LottieAnimationView (lottie API)

java.lang.Object
- AppCompatImageView
- - com.airbnb.lottie.LottieAnimationView

```
public class LottieAnimationView
extends AppCompatImageView
```
This view will load, deserialize, and display an After Effects animation exported with bodymovin (https://github.com/bodymovin/bodymovin).
You may set the animation in one of two ways: 1) Attrs: R.styleable#LottieAnimationView_lottie_fileName 2) Programatically: setAnimation(String), setComposition(LottieComposition), or setAnimation(JSONObject).
You can set a default cache strategy with R.attr#lottie_cacheStrategy.
You can manually set the progress of the animation with setProgress(float) or R.attr#lottie_progress

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LottieAnimationView.CacheStrategy
Caching strategy for compositions that will be reused frequently.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LottieAnimationView.CacheStrategy` Caching strategy for compositions that will be reused frequently.

Constructor Summary

Constructors
Constructor and Description
`LottieAnimationView(android.content.Context context)`
`LottieAnimationView(android.content.Context context, android.util.AttributeSet attrs)`
`LottieAnimationView(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)`

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)`
`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`	`enableMergePathsForKitKatAndAbove(boolean enable)` Enable this to get merge path support for devices running KitKat (19) and above.
`long`	`getDuration()`
`int`	`getFrame()` Get the currently rendered frame.
`java.lang.String`	`getImageAssetsFolder()`
`PerformanceTracker`	`getPerformanceTracker()`
`float`	`getProgress()`
`float`	`getScale()`
`float`	`getSpeed()` Returns the current playback speed.
`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 dr)`
`boolean`	`isAnimating()`
`void`	`loop(boolean loop)`
`protected void`	`onAttachedToWindow()`
`protected void`	`onDetachedFromWindow()`
`protected void`	`onRestoreInstanceState(android.os.Parcelable state)`
`protected android.os.Parcelable`	`onSaveInstanceState()`
`void`	`pauseAnimation()`
`void`	`playAnimation()` Plays the animation from the beginning.
`void`	`removeAnimatorListener(android.animation.Animator.AnimatorListener listener)`
`void`	`removeUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)`
`void`	`resumeAnimation()` Continues playing the animation from its current position.
`void`	`reverseAnimationSpeed()` Reverses the current animation speed.
`void`	`setAnimation(int animationResId)` Sets the animation from a file in the raw directory.
`void`	`setAnimation(int animationResId, LottieAnimationView.CacheStrategy cacheStrategy)` Sets the animation from a file in the raw directory.
`void`	`setAnimation(org.json.JSONObject json)` Sets the animation from a JSONObject.
`void`	`setAnimation(java.lang.String animationName)` Sets the animation from a file in the assets directory.
`void`	`setAnimation(java.lang.String animationName, LottieAnimationView.CacheStrategy cacheStrategy)` Sets the animation from a file in the assets directory.
`void`	`setComposition(LottieComposition composition)` Sets a 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`	`setImageAssetsFolder(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`	`setImageBitmap(android.graphics.Bitmap bm)`
`void`	`setImageDrawable(android.graphics.drawable.Drawable drawable)`
`void`	`setImageResource(int resId)`
`void`	`setMaxFrame(int endFrame)` Sets the maximum frame that the animation will end at when playing or looping.
`void`	`setMaxProgress(float endProgress)` 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 startFrame)` Sets the minimum frame that the animation will start from when playing or looping.
`void`	`setMinProgress(float startProgress)` 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)` Set this to replace animation text with custom text at runtime
`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 `setImageAssetsFolder(String)` or with an `ImageAssetDelegate`.
`void`	`useExperimentalHardwareAcceleration()` Deprecated.
`void`	`useExperimentalHardwareAcceleration(boolean use)` Deprecated.
`void`	`useHardwareAcceleration()`
`void`	`useHardwareAcceleration(boolean use)` Enable hardware acceleration for this view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LottieAnimationView
```
public LottieAnimationView(android.content.Context context)
```
  - LottieAnimationView
```
public LottieAnimationView(android.content.Context context,
                           android.util.AttributeSet attrs)
```
  - LottieAnimationView
```
public LottieAnimationView(android.content.Context context,
                           android.util.AttributeSet attrs,
                           int defStyleAttr)
```
- Method Detail
  - setImageResource
```
public void setImageResource(int resId)
```
  - setImageDrawable
```
public void setImageDrawable(android.graphics.drawable.Drawable drawable)
```
  - setImageBitmap
```
public void setImageBitmap(android.graphics.Bitmap bm)
```
  - 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
  - invalidateDrawable
```
public void invalidateDrawable(android.graphics.drawable.Drawable dr)
```
  - onSaveInstanceState
```
protected android.os.Parcelable onSaveInstanceState()
```
  - onRestoreInstanceState
```
protected void onRestoreInstanceState(android.os.Parcelable state)
```
  - onAttachedToWindow
```
protected void onAttachedToWindow()
```
  - onDetachedFromWindow
```
protected void onDetachedFromWindow()
```
  - 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.
  - useExperimentalHardwareAcceleration
```
@Deprecated
public void useExperimentalHardwareAcceleration()
```
    Deprecated.
    
    See Also:
    
    useHardwareAcceleration(boolean)
  - useExperimentalHardwareAcceleration
```
@Deprecated
public void useExperimentalHardwareAcceleration(boolean use)
```
    Deprecated.
    
    See Also:
    
    useHardwareAcceleration(boolean)
  - useHardwareAcceleration
```
public void useHardwareAcceleration()
```
    See Also:
    
    useHardwareAcceleration(boolean)
  - useHardwareAcceleration
```
public void useHardwareAcceleration(boolean use)
```
    Enable hardware acceleration for this view. READ THIS BEFORE ENABLING HARDWARE ACCELERATION: 1) Test your animation on the minimum API level you support. Some drawing features such as dashes and stroke caps have min api levels (https://developer.android.com/guide/topics/graphics/hardware-accel.html#unsupported) 2) Enabling hardware acceleration is not always more performant. Check it with your specific animation only if you are having performance issues with software rendering. 3) Software rendering is safer and will be consistent across devices. Manufacturers can potentially break hardware rendering with bugs in their SKIA engine. Lottie cannot do anything about that.
  - setAnimation
```
public void setAnimation(int animationResId)
```
    Sets the animation from a file in the raw directory. This will load and deserialize the file asynchronously.
    Will not cache the composition once loaded.
  - setAnimation
```
public void setAnimation(int animationResId,
                         LottieAnimationView.CacheStrategy cacheStrategy)
```
    Sets the animation from a file in the raw directory. This will load and deserialize the file asynchronously.
    You may also specify a cache strategy. Specifying LottieAnimationView.CacheStrategy.Strong will hold a strong reference to the composition once it is loaded and deserialized. LottieAnimationView.CacheStrategy.Weak will hold a weak reference to said composition.
  - setAnimation
```
public void setAnimation(java.lang.String animationName)
```
    Sets the animation from a file in the assets directory. This will load and deserialize the file asynchronously.
    Will not cache the composition once loaded.
  - setAnimation
```
public void setAnimation(java.lang.String animationName,
                         LottieAnimationView.CacheStrategy cacheStrategy)
```
    Sets the animation from a file in the assets directory. This will load and deserialize the file asynchronously.
    You may also specify a cache strategy. Specifying LottieAnimationView.CacheStrategy.Strong will hold a strong reference to the composition once it is loaded and deserialized. LottieAnimationView.CacheStrategy.Weak will hold a weak reference to said composition.
  - setAnimation
```
public void setAnimation(org.json.JSONObject json)
```
    Sets the animation from a JSONObject. This will load and deserialize the file asynchronously.
    This is particularly useful for animations loaded from the network. You can fetch the bodymovin json from the network and pass it directly here.
  - setComposition
```
public void setComposition(LottieComposition composition)
```
    Sets a composition. You can set a default cache strategy if this view was inflated with xml by using R.attr#lottie_cacheStrategy.
  - 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.
  - 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 startFrame)
```
    Sets the minimum frame that the animation will start from when playing or looping.
  - setMinProgress
```
public void setMinProgress(float startProgress)
```
    Sets the minimum progress that the animation will start from when playing or looping.
  - setMaxFrame
```
public void setMaxFrame(int endFrame)
```
    Sets the maximum frame that the animation will end at when playing or looping.
  - setMaxProgress
```
public void setMaxProgress(float endProgress)
```
    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)
```
  - removeUpdateListener
```
public void removeUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
```
  - addAnimatorListener
```
public void addAnimatorListener(android.animation.Animator.AnimatorListener listener)
```
  - removeAnimatorListener
```
public void removeAnimatorListener(android.animation.Animator.AnimatorListener listener)
```
  - loop
```
public void loop(boolean loop)
```
  - isAnimating
```
public boolean isAnimating()
```
  - setImageAssetsFolder
```
public void setImageAssetsFolder(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/");`.
  - getImageAssetsFolder
```
public java.lang.String getImageAssetsFolder()
```
  - 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 setImageAssetsFolder(String) or with an ImageAssetDelegate.
    
    Returns:
    
    the previous Bitmap or null.
  - 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)
```
    Set this to replace animation text with custom text at runtime
  - 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.
  - getScale
```
public float getScale()
```
  - cancelAnimation
```
public void cancelAnimation()
```
  - pauseAnimation
```
public void pauseAnimation()
```
  - 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)
```
  - getProgress
```
public float getProgress()
```
  - getDuration
```
public long getDuration()
```
  - setPerformanceTrackingEnabled
```
public void setPerformanceTrackingEnabled(boolean enabled)
```
  - getPerformanceTracker
```
public PerformanceTracker getPerformanceTracker()
```

Class LottieAnimationView

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LottieAnimationView

LottieAnimationView

LottieAnimationView

Method Detail

setImageResource

setImageDrawable

setImageBitmap

addColorFilterToContent

addColorFilterToLayer

addColorFilter

clearColorFilters

invalidateDrawable

onSaveInstanceState

onRestoreInstanceState

onAttachedToWindow

onDetachedFromWindow

enableMergePathsForKitKatAndAbove

useExperimentalHardwareAcceleration

useExperimentalHardwareAcceleration

useHardwareAcceleration

useHardwareAcceleration

setAnimation

setAnimation

setAnimation

setAnimation

setAnimation

setComposition

hasMasks

hasMatte

playAnimation

resumeAnimation

setMinFrame

setMinProgress

setMaxFrame

setMaxProgress

setMinAndMaxFrame

setMinAndMaxProgress

reverseAnimationSpeed

setSpeed

getSpeed

addAnimatorUpdateListener

removeUpdateListener

addAnimatorListener

removeAnimatorListener

loop

isAnimating

setImageAssetsFolder

getImageAssetsFolder

updateBitmap

setImageAssetDelegate

setFontAssetDelegate

setTextDelegate

setScale

getScale

cancelAnimation

pauseAnimation

setFrame

getFrame

setProgress

getProgress

getDuration

setPerformanceTrackingEnabled

getPerformanceTracker