public class AnimatedImageDrawable

extends Drawable implements Animatable2

Drawable for drawing animated images (like GIF).

The framework handles decoding subsequent frames in another thread and updating when necessary. The drawable will only animate while it is being displayed.

Created by ImageDecoder#decodeDrawable . A user needs to call start() to start the animation.

It can also be defined in XML using the <animated-image> element.

XML attributes

android:autoMirrored Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left).

android:autoStart When true, automatically start animating.

android:repeatCount Replace the loop count in the encoded data.

android:src Identifier of the image file.

Constants int REPEAT_INFINITE Pass this to setRepeatCount(int) to repeat infinitely.

Public constructors AnimatedImageDrawable() Create an empty AnimatedImageDrawable.

Public methods void clearAnimationCallbacks() Removes all existing animation callbacks. void draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). int getAlpha() Gets the current alpha value for the drawable. ColorFilter getColorFilter() Returns the current color filter, or null if none set. int getIntrinsicHeight() Returns the drawable's intrinsic height. int getIntrinsicWidth() Returns the drawable's intrinsic width. int getOpacity() This method is deprecated. This method is no longer used in graphics optimizations int getRepeatCount() Retrieve the number of times the animation will repeat. void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme. final boolean isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. boolean isRunning() Return whether the animation is currently running. boolean onLayoutDirectionChanged(int layoutDirection) Called when the drawable's resolved layout direction changes. void registerAnimationCallback(Animatable2.AnimationCallback callback) Adds a callback to listen to the animation events. void setAlpha(int alpha) Specify an alpha value for the drawable. void setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). void setColorFilter(ColorFilter colorFilter) Specify an optional color filter for the drawable. void setRepeatCount(int repeatCount) Specify the number of times to repeat the animation. void start() Start the animation. void stop() Stop the animation. boolean unregisterAnimationCallback(Animatable2.AnimationCallback callback) Removes the specified animation callback.

Inherited methods android.graphics.drawable.Drawable From class void applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children. boolean canApplyTheme() void clearColorFilter() Removes the color filter for this drawable. final Rect copyBounds() Return a copy of the drawable's bounds in a new Rect. final void copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). static Drawable createFromPath(String pathName) Create a drawable from file path name. static Drawable createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) This method was deprecated in API level 28. Prefer the version without an Options object. static Drawable createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information. static Drawable createFromStream(InputStream is, String srcName) Create a drawable from an inputstream static Drawable createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document. static Drawable createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional Theme . static Drawable createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional Theme . static Drawable createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document. abstract void draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). int getAlpha() Gets the current alpha value for the drawable. final Rect getBounds() Return the drawable's bounds Rect. Drawable.Callback getCallback() Return the current Callback implementation attached to this Drawable. int getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. ColorFilter getColorFilter() Returns the current color filter, or null if none set. Drawable.ConstantState getConstantState() Return a ConstantState instance that holds the shared state of this Drawable. Drawable getCurrent() Rect getDirtyBounds() Return the drawable's dirty bounds Rect. void getHotspotBounds(Rect outRect) Populates outRect with the hotspot bounds. int getIntrinsicHeight() Returns the drawable's intrinsic height. int getIntrinsicWidth() Returns the drawable's intrinsic width. int getLayoutDirection() Returns the resolved layout direction for this Drawable. final int getLevel() Retrieve the current level. int getMinimumHeight() Returns the minimum height suggested by this Drawable. int getMinimumWidth() Returns the minimum width suggested by this Drawable. abstract int getOpacity() This method was deprecated in API level 29. This method is no longer used in graphics optimizations Insets getOpticalInsets() Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout. void getOutline(Outline outline) Called to get the drawable to populate the Outline that defines its drawing area. boolean getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. int[] getState() Describes the current state, as a union of primitve states, such as R.attr.state_focused , R.attr.state_selected , etc. Region getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent. void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme. void inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource. void invalidateSelf() Use the current Callback implementation to have this Drawable redrawn. boolean isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. boolean isFilterBitmap() boolean isProjected() Whether this drawable requests projection. boolean isStateful() Indicates whether this drawable will change its appearance based on state. final boolean isVisible() void jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. Drawable mutate() Make this drawable mutable. void onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds. boolean onLayoutDirectionChanged(int layoutDirection) Called when the drawable's resolved layout direction changes. boolean onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level. boolean onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state. static int resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities. void scheduleSelf(Runnable what, long when) Use the current Callback implementation to have this Drawable scheduled. abstract void setAlpha(int alpha) Specify an alpha value for the drawable. void setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). void setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable. void setBounds(Rect bounds) Specify a bounding rectangle for the Drawable. final void setCallback(Drawable.Callback cb) Bind a Callback object to this Drawable. void setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. void setColorFilter(int color, PorterDuff.Mode mode) This method was deprecated in API level 29. use setColorFilter(android.graphics.ColorFilter) with an instance of BlendModeColorFilter abstract void setColorFilter(ColorFilter colorFilter) Specify an optional color filter for the drawable. void setDither(boolean dither) This method was deprecated in API level 23. This property is ignored. void setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. void setHotspot(float x, float y) Specifies the hotspot's location within the drawable. void setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds. final boolean setLayoutDirection(int layoutDirection) Set the layout direction for this drawable. final boolean setLevel(int level) Specify the level for the drawable. boolean setState(int[] stateSet) Specify a set of states for the drawable. void setTint(int tintColor) Specifies tint color for this drawable. void setTintBlendMode(BlendMode blendMode) Specifies a tint blending mode for this drawable. void setTintList(ColorStateList tint) Specifies tint color for this drawable as a color state list. void setTintMode(PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable. boolean setVisible(boolean visible, boolean restart) Set whether this Drawable is visible. void unscheduleSelf(Runnable what) Use the current Callback implementation to have this Drawable unscheduled. java.lang.Object From class Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object . int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. android.graphics.drawable.Animatable2 From interface abstract void clearAnimationCallbacks() Removes all existing animation callbacks. abstract void registerAnimationCallback(Animatable2.AnimationCallback callback) Adds a callback to listen to the animation events. abstract boolean unregisterAnimationCallback(Animatable2.AnimationCallback callback) Removes the specified animation callback. android.graphics.drawable.Animatable From interface abstract boolean isRunning() Indicates whether the animation is running. abstract void start() Starts the drawable's animation. abstract void stop() Stops the drawable's animation.

XML attributes

android:autoMirrored

Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left).

May be a boolean value, such as " true " or " false ".

android:autoStart

When true, automatically start animating. The default is false, meaning that the animation will not start until start() is called.

May be a boolean value, such as " true " or " false ".

android:repeatCount

Replace the loop count in the encoded data. A repeat count of 0 means that the animation will play once, regardless of the number of times specified in the encoded data. Setting this to infinite (-1) will result in the animation repeating as long as it is displayed (once start() is called).

May be an integer value, such as " 100 ".

Must be one of the following constant values.

Constant Value Description infinite ffffffff

android:src

Identifier of the image file. This attribute is mandatory. It must be an image file with multiple frames, e.g. gif or webp

May be a reference to another resource, in the form " @[+][package:]type/name " or a theme attribute in the form " ?[package:]type/name ".

May be a color value, in the form of " #rgb ", " #argb ", " #rrggbb ", or " #aarrggbb ".

Constants

REPEAT_INFINITE Added in API level 28 public static final int REPEAT_INFINITE Pass this to setRepeatCount(int) to repeat infinitely. Animatable2.AnimationCallback#onAnimationEnd will never be called unless there is an error. Constant Value: -1 (0xffffffff)

Public constructors

AnimatedImageDrawable Added in API level 28 public AnimatedImageDrawable () Create an empty AnimatedImageDrawable.

Public methods

clearAnimationCallbacks Added in API level 28 public void clearAnimationCallbacks () Removes all existing animation callbacks.

draw Added in API level 28 public void draw (Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). Parameters canvas Canvas : This value cannot be null .

getAlpha Added in API level 28 public int getAlpha () Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha. Returns int Value is between 0 and 255 inclusive

getColorFilter Added in API level 28 public ColorFilter getColorFilter () Returns the current color filter, or null if none set. Returns ColorFilter This value may be null .

getIntrinsicHeight Added in API level 28 public int getIntrinsicHeight () Returns the drawable's intrinsic height. Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1. Returns int the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth Added in API level 28 public int getIntrinsicWidth () Returns the drawable's intrinsic width. Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1. Returns int the intrinsic width, or -1 if no intrinsic width

getOpacity Added in API level 28 public int getOpacity () This method is deprecated.

This method is no longer used in graphics optimizations Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat : PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE . An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT. Generally a Drawable should be as conservative as possible with the value it returns. For example, if it contains multiple child drawables and only shows one of them at a time, if only one of the children is TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be returned. You can use the method resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output. Note that the returned value does not necessarily take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods. Some subclasses, such as BitmapDrawable , ColorDrawable , and GradientDrawable , do account for the value of setAlpha(int) , but the general behavior is dependent upon the implementation of the subclass. Returns int Value is PixelFormat.UNKNOWN , PixelFormat.TRANSLUCENT , PixelFormat.TRANSPARENT , or PixelFormat.OPAQUE

getRepeatCount Added in API level 28 public int getRepeatCount () Retrieve the number of times the animation will repeat. By default, the repeat count in the encoded data is respected. If the value is REPEAT_INFINITE , the animation will repeat as long as it is displayed. If the value is 0 , it will play once. Calling setRepeatCount(int) will make future calls to this method return the value passed to setRepeatCount(int) . Returns int

inflate Added in API level 28 public void inflate (Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource. Parameters r Resources : Resources used to resolve attribute values This value cannot be null . parser XmlPullParser : XML parser from which to inflate this Drawable This value cannot be null . attrs AttributeSet : Base set of attribute values This value cannot be null . theme Resources.Theme : Theme to apply, may be null This value may be null . Throws IOException XmlPullParserException

isAutoMirrored Added in API level 28 public final boolean isAutoMirrored () Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection . Returns boolean boolean Returns true if this Drawable will be automatically mirrored.

isRunning Added in API level 28 public boolean isRunning () Return whether the animation is currently running. When this drawable is created, this will return false . A client needs to call start() to start the animation. Returns boolean True if the animation is running, false otherwise.

onLayoutDirectionChanged Added in API level 28 public boolean onLayoutDirectionChanged (int layoutDirection) Called when the drawable's resolved layout direction changes. Parameters layoutDirection int : the new resolved layout direction Value is View.LAYOUT_DIRECTION_LTR , or View.LAYOUT_DIRECTION_RTL Returns boolean true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise

registerAnimationCallback Added in API level 28 public void registerAnimationCallback (Animatable2.AnimationCallback callback) Adds a callback to listen to the animation events. Parameters callback Animatable2.AnimationCallback : This value cannot be null .

setAlpha Added in API level 28 public void setAlpha (int alpha) Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque. Parameters alpha int : Value is between 0 and 255 inclusive

setAutoMirrored Added in API level 28 public void setAutoMirrored (boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection . Parameters mirrored boolean : Set to true if the Drawable should be mirrored, false if not.

setColorFilter Added in API level 28 public void setColorFilter (ColorFilter colorFilter) Specify an optional color filter for the drawable. If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas. Pass null to remove any existing color filter. Note: Setting a non- null color filter disables tint . Parameters colorFilter ColorFilter : This value may be null .

setRepeatCount Added in API level 28 public void setRepeatCount (int repeatCount) Specify the number of times to repeat the animation. By default, the repeat count in the encoded data is respected. If set to REPEAT_INFINITE , the animation will repeat as long as it is displayed. If the value is 0 , the animation will play once. This call replaces the current repeat count. If the encoded data specified a repeat count of 2 (meaning that getRepeatCount() returns 2 , the animation will play three times. Calling setRepeatCount(1) will result in playing only twice and getRepeatCount() returning 1 . If the animation is already playing, the iterations that have already occurred count towards the new count. If the animation has already repeated the appropriate number of times (or more), it will finish its current iteration and then stop. Parameters repeatCount int : Value is REPEAT_INFINITE or greater

start Added in API level 28 public void start () Start the animation. Does nothing if the animation is already running. If the animation is stopped, this will reset it. When the drawable is drawn, starting the animation, Animatable2.AnimationCallback#onAnimationStart will be called.

stop Added in API level 28 public void stop () Stop the animation. If the animation is stopped, it will continue to display the frame it was displaying when stopped.

unregisterAnimationCallback Added in API level 28 public boolean unregisterAnimationCallback (Animatable2.AnimationCallback callback) Removes the specified animation callback. Parameters callback Animatable2.AnimationCallback : This value cannot be null . Returns boolean false if callback didn't exist in the call back list, or true if callback has been removed successfully.