All Implemented Interfaces:

android.graphics.drawable.Animatable , androidx.vectordrawable.graphics.drawable.Animatable2Compat
```
public final class ApngDrawable
extends Drawable implements Animatable2Compat
                    
```
An animated Drawable that plays the frames of an animated PNG.
This drawable holds ApngState.apng which contains the width, height, image count, duration and repeat count from APNG meta data. These meta data can be obtained with decode function.
Also ApngState.apng has other responsibility to draw given frame to a canvas. ApngDrawable delegates ApngState.apng to draw a frame.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`ApngDrawable.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`durationMillis`
`private final Integer`	`frameCount`
`private final List<Integer>`	`frameDurations`
`private final Integer`	`frameByteCount`
`private final Long`	`allocationByteCount`
`private Integer`	`loopCount`
`private final Boolean`	`isRecycled`
`private final Integer`	`currentRepeatCount`
`private final Integer`	`currentLoopIndex`
`private final Integer`	`currentFrameIndex`

Method Summary

Modifier and Type	Method	Description
`Unit`	`draw(Canvas canvas)`
`Unit`	`setAlpha(Integer alpha)`
`Integer`	`getOpacity()`
`Unit`	`setColorFilter(ColorFilter colorFilter)`
`Integer`	`getIntrinsicWidth()`
`Integer`	`getIntrinsicHeight()`
`Boolean`	`isRunning()`
`Unit`	`start()`
`Unit`	`stop()`
`Unit`	`registerAnimationCallback(Animatable2Compat.AnimationCallback callback)`	Adds callback to listen animation start and end event of this apng image.
`Boolean`	`unregisterAnimationCallback(Animatable2Compat.AnimationCallback callback)`
`final Unit`	`registerRepeatAnimationCallback(RepeatAnimationCallback repeatCallback)`
`final Boolean`	`unregisterRepeatAnimationCallback(RepeatAnimationCallback repeatCallback)`
`Unit`	`clearAnimationCallbacks()`
`Drawable.ConstantState`	`getConstantState()`
`Drawable`	`mutate()`
`final Unit`	`setTargetDensity(DisplayMetrics metrics)`	Sets the density scale at which this drawable will be rendered.
`final Unit`	`seekTo(Long positionMillis)`	Seeks frame to given position and show the image with target frame.
`final Unit`	`seekToFrame(Integer loopIndex, Integer frameIndex)`	Seeks frame to given frame index with loop index.
`final Unit`	`recycle()`	Releases resources managed by the native layer.
`final Integer`	`getDurationMillis()`	The duration to animate one loop of APNG animation.
`final Integer`	`getFrameCount()`	The number of frames included in this APNG image.
`final List<Integer>`	`getFrameDurations()`	A list of time to draw each frame in milliseconds.
`final Integer`	`getFrameByteCount()`	The number of bytes required for the non-native layer.
`final Long`	`getAllocationByteCount()`	The size of memory required for this image, including all frames loaded in the native layer.
`final Integer`	`getLoopCount()`	The number of times to loop this APNG image.
`final Boolean`	`getIsRecycled()`	Whether this drawable has already been destroyed or not.
`final Integer`	`getCurrentRepeatCount()`
`final Integer`	`getCurrentLoopIndex()`
`final Integer`	`getCurrentFrameIndex()`
`final Unit`	`setLoopCount(Integer loopCount)`

Methods inherited from class com.linecorp.apng.ApngDrawable
applyTheme, canApplyTheme, clearColorFilter, copyBounds, copyBounds, getAlpha, getBounds, getCallback, getChangingConfigurations, getColorFilter, getCurrent, getDirtyBounds, getHotspotBounds, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getOpticalInsets, getOutline, getPadding, getState, getTransparentRegion, inflate, inflate, invalidateSelf, isAutoMirrored, isFilterBitmap, isProjected, isStateful, isVisible, jumpToCurrentState, onBoundsChange, onLayoutDirectionChanged, onLevelChange, onStateChange, scheduleSelf, setAutoMirrored, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setLayoutDirection, setLevel, setState, setTint, setTintBlendMode, setTintList, setTintMode, setVisible, unscheduleSelf
Methods inherited from class android.graphics.drawable.Drawable
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - draw
```
 Unit draw(Canvas canvas)
```
  - setAlpha
```
 Unit setAlpha(Integer alpha)
```
  - getOpacity
```
 Integer getOpacity()
```
  - setColorFilter
```
 Unit setColorFilter(ColorFilter colorFilter)
```
  - getIntrinsicWidth
```
 Integer getIntrinsicWidth()
```
  - getIntrinsicHeight
```
 Integer getIntrinsicHeight()
```
  - isRunning
```
 Boolean isRunning()
```
  - start
```
 Unit start()
```
  - stop
```
 Unit stop()
```
  - registerAnimationCallback
```
 Unit registerAnimationCallback(Animatable2Compat.AnimationCallback callback)
```
    Adds callback to listen animation start and end event of this apng image. Animation end event will happen after exceeds loopCount.
    Note: The animation end callback will be called only when animation stops beyond the loop count limit. In order to prevent potential memory leak, unregister the callback or clear all callbacks.
    
    Parameters:
    
    callback - The Animatable2Compat.AnimationCallback to notify events.
  - unregisterAnimationCallback
```
 Boolean unregisterAnimationCallback(Animatable2Compat.AnimationCallback callback)
```
  - registerRepeatAnimationCallback
```
 final Unit registerRepeatAnimationCallback(RepeatAnimationCallback repeatCallback)
```
  - unregisterRepeatAnimationCallback
```
 final Boolean unregisterRepeatAnimationCallback(RepeatAnimationCallback repeatCallback)
```
  - clearAnimationCallbacks
```
 Unit clearAnimationCallbacks()
```
  - getConstantState
```
 Drawable.ConstantState getConstantState()
```
  - mutate
```
 Drawable mutate()
```
  - setTargetDensity
```
 final Unit setTargetDensity(DisplayMetrics metrics)
```
    Sets the density scale at which this drawable will be rendered. If ApngState.sourceDensity is Bitmap.DENSITY_NONE, this value is ignored.
    
    Parameters:
    
    metrics - The DisplayMetrics indicating the density scale for this drawable.
  - seekTo
```
 final Unit seekTo(Long positionMillis)
```
    Seeks frame to given position and show the image with target frame. If given position is larger than total duration of animation,
    
    Parameters:
    
    positionMillis - Time to seek in milliseconds
  - seekToFrame
```
 final Unit seekToFrame(Integer loopIndex, Integer frameIndex)
```
    Seeks frame to given frame index with loop index.
    
    Parameters:
    
    loopIndex - The target loop index to seek.
    
    frameIndex - The target frame index to seek.
  - recycle
```
 final Unit recycle()
```
    Releases resources managed by the native layer. Call this image when it is no longer used.
  - getDurationMillis
```
 final Integer getDurationMillis()
```
    The duration to animate one loop of APNG animation.
  - getFrameCount
```
 final Integer getFrameCount()
```
    The number of frames included in this APNG image.
  - getFrameDurations
```
 final List<Integer> getFrameDurations()
```
    A list of time to draw each frame in milliseconds.
  - getFrameByteCount
```
 final Integer getFrameByteCount()
```
    The number of bytes required for the non-native layer. In most cases, this is the number of bytes used to display one frame.
  - getAllocationByteCount
```
 final Long getAllocationByteCount()
```
    The size of memory required for this image, including all frames loaded in the native layer.
  - getLoopCount
```
 final Integer getLoopCount()
```
    The number of times to loop this APNG image. The value must be a signed value or special values.
    The special values are:
    LOOP_FOREVER indicates infinite looping.
    LOOP_INTRINSIC indicated the default looping count.
  - getIsRecycled
```
 final Boolean getIsRecycled()
```
    Whether this drawable has already been destroyed or not.
  - getCurrentRepeatCount
```
 final Integer getCurrentRepeatCount()
```
  - getCurrentLoopIndex
```
 final Integer getCurrentLoopIndex()
```
  - getCurrentFrameIndex
```
 final Integer getCurrentFrameIndex()
```
  - setLoopCount
```
 final Unit setLoopCount(Integer loopCount)
```

Class ApngDrawable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class com.linecorp.apng.ApngDrawable

Methods inherited from class android.graphics.drawable.Drawable

Methods inherited from class java.lang.Object

Method Detail

draw

setAlpha

getOpacity

setColorFilter

getIntrinsicWidth

getIntrinsicHeight

isRunning

start

stop

registerAnimationCallback

unregisterAnimationCallback

registerRepeatAnimationCallback

unregisterRepeatAnimationCallback

clearAnimationCallbacks

getConstantState

mutate

setTargetDensity

seekTo

seekToFrame

recycle

getDurationMillis

getFrameCount

getFrameDurations

getFrameByteCount

getAllocationByteCount

getLoopCount

getIsRecycled

getCurrentRepeatCount

getCurrentLoopIndex

getCurrentFrameIndex

setLoopCount