com.airbnb.lottie

Class LottieAnimationView

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.

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

Modifier and Type	Method and Description
void	addAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	cancelAnimation()
void	enableMergePathsForKitKatAndAbove(boolean enable) Enable this to get merge path support for devices running KitKat (19) and above.
long	getDuration()
float	getProgress()
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()
void	removeAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	removeUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	resumeAnimation()
void	resumeReverseAnimation()
void	reverseAnimation()
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	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	setImageDrawable(android.graphics.drawable.Drawable drawable)
void	setImageResource(int resId)
void	setProgress(float progress)
void	setSpeed(float speed)
void	useExperimentalHardwareAcceleration() 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)

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

public void useExperimentalHardwareAcceleration()

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(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.

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/");`.

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()

playAnimation

public void playAnimation()

resumeAnimation

public void resumeAnimation()

reverseAnimation

public void reverseAnimation()

resumeReverseAnimation

public void resumeReverseAnimation()

setSpeed

public void setSpeed(float speed)

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.

cancelAnimation

public void cancelAnimation()

pauseAnimation

public void pauseAnimation()

setProgress

public void setProgress(float progress)

getProgress

public float getProgress()

getDuration

public long getDuration()