AnimatedImageDrawable

Kotlin |Java

open class AnimatedImageDrawable : Drawable, Animatable2

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.AnimatedImageDrawable

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 android.graphics.ImageDecoder#decodeDrawable. A user needs to call start to start the animation.

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

Summary

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
static Int	`REPEAT_INFINITE` Pass this to `setRepeatCount` to repeat infinitely.

Public constructors
`AnimatedImageDrawable()` Create an empty AnimatedImageDrawable.

Public methods
open Unit	`clearAnimationCallbacks()` Removes all existing animation callbacks.
open Unit	`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).
open Int	`getAlpha()` Gets the current alpha value for the drawable.
open ColorFilter?	`getColorFilter()` Returns the current color filter, or `null` if none set.
open Int	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
open Int	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
open Int	`getOpacity()` Return the opacity/transparency of this Drawable.
open Int	`getRepeatCount()` Retrieve the number of times the animation will repeat.
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme.
Boolean	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
open Boolean	`isFilterBitmap()`
open Boolean	`isRunning()` Return whether the animation is currently running.
open Boolean	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
open Unit	`registerAnimationCallback(callback: Animatable2.AnimationCallback)` Adds a callback to listen to the animation events.
open Unit	`setAlpha(alpha: Int)` Specify an alpha value for the drawable.
open Unit	`setAutoMirrored(mirrored: Boolean)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
open Unit	`setColorFilter(colorFilter: ColorFilter?)` Specify an optional color filter for the drawable.
open Unit	`setFilterBitmap(filterBitmap: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
open Unit	`setRepeatCount(repeatCount: Int)` Specify the number of times to repeat the animation.
open Unit	`start()` Start the animation.
open Unit	`stop()` Stop the animation.
open Boolean	`unregisterAnimationCallback(callback: Animatable2.AnimationCallback)` Removes the specified animation callback.

Protected methods
open Unit	`onBoundsChange(bounds: Rect)` Override this in your subclass to change appearance if you vary based on the bounds.

Inherited functions

From class Drawable

`Unit`	`applyTheme(t: Resources.Theme)` Applies the specified theme to this Drawable and its children.
`Boolean`	`canApplyTheme()`
`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`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. The default implementation returns whatever was provided through `setChangingConfigurations(int)` or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
`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. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Unit`	`getHotspotBounds(outRect: Rect)` Populates `outRect` with the hotspot bounds.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`Int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding.
`Insets`	`getOpticalInsets()` Return in insets the layout insets suggested by this Drawable for use with alignment operations during layout.
`Unit`	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area. This method is called by the default `android.view.ViewOutlineProvider` to define the outline of the View. The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.
`Boolean`	`getPadding(padding: Rect)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Boolean`	`hasFocusStateSpecified()` Indicates whether this drawable has at least one state spec explicitly specifying `android.R.attr#state_focused`. Note: A View uses a `Drawable` instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its `android.R.attr#state_focused` to make sure the user knows which view is holding the focus.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isProjected()` Whether this drawable requests projection. Indicates that the `android.graphics.RenderNode` this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
`Boolean`	`isStateful()` Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
`Boolean`	`isVisible()`
`Unit`	`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. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.
`Boolean`	`onLevelChange(level: Int)` Override this in your subclass to change appearance if you vary based on level.
`Boolean`	`onStateChange(state: IntArray)` Override this in your subclass to change appearance if you recognize the specified state.
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setDither(dither: Boolean)` Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component.
`Unit`	`setHotspot(x: Float, y: Float)` Specifies the hotspot's location within the drawable.
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)` Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintBlendMode(blendMode: BlendMode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `BlendMode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)`
`Unit`	`setTintList(tint: ColorStateList?)` Specifies tint color for this drawable as a color state list. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `PorterDuff.Mode.SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Boolean`	`setVisible(visible: Boolean, restart: Boolean)` Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:autoMirrored

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

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

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

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

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

Exceptions
`java.io.IOException`
`org.xmlpull.v1.XmlPullParserException`

AnimatedImageDrawable

Summary

XML attributes

android:autoMirrored

android:autoStart

android:repeatCount

android:src

Constants

REPEAT_INFINITE

Public constructors

AnimatedImageDrawable

Public methods

clearAnimationCallbacks

draw

getAlpha

getColorFilter

getIntrinsicHeight

getIntrinsicWidth

getOpacity

getRepeatCount

inflate

isAutoMirrored

isFilterBitmap

isRunning

onLayoutDirectionChanged

registerAnimationCallback

setAlpha

setAutoMirrored

setColorFilter

setFilterBitmap

setRepeatCount

start

stop

unregisterAnimationCallback

Protected methods

onBoundsChange