public class

WebPImage

extends Object
implements AnimatedImage AnimatedImageDecoder
java.lang.Object
   ↳ com.facebook.animated.webp.WebPImage

Class Overview

A representation of a WebP image. An instance of this class will hold a copy of the encoded data in memory along with the parsed header data. Frames are decoded on demand via WebPFrame.

Summary

[Expand]
Inherited Constants
From interface com.facebook.imagepipeline.animated.base.AnimatedImage
Public Constructors
WebPImage()
Public Methods
static WebPImage create(byte[] source)
Creates a WebPImage from the specified encoded data.
static WebPImage create(long nativePtr, int sizeInBytes)
AnimatedImage decode(long nativePtr, int sizeInBytes)
Factory method to create the AnimatedImage from the
void dispose()
Disposes the instance.
boolean doesRenderSupportScaling()
Returns whether renderFrame(int, int, Bitmap) supports scaling to arbitrary sizes or whether scaling must be done externally.
int getDuration()
Gets the duration of the animated image.
WebPFrame getFrame(int frameNumber)
Creates an AnimatedImageFrame at the specified index.
int getFrameCount()
Gets the number of frames in the image.
int[] getFrameDurations()
Gets the duration of each frame of the animated image.
AnimatedDrawableFrameInfo getFrameInfo(int frameNumber)
Gets the frame info for the specified frame.
int getHeight()
Gets the height of the image (also known as the canvas in WebP nomenclature).
int getLoopCount()
Gets the number of loops to run the animation for.
int getSizeInBytes()
Gets the size of bytes of the encoded image data (which is the data kept in memory for the image).
int getWidth()
Gets the width of the image (also known as the canvas in WebP nomenclature).
Protected Methods
void finalize()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.facebook.imagepipeline.animated.base.AnimatedImage
From interface com.facebook.imagepipeline.animated.factory.AnimatedImageDecoder

Public Constructors

public WebPImage ()

Public Methods

public static WebPImage create (byte[] source)

Creates a WebPImage from the specified encoded data. This will throw if it fails to create. This is meant to be called on a worker thread.

Parameters
source the data to the image (a copy will be made)

public static WebPImage create (long nativePtr, int sizeInBytes)

public AnimatedImage decode (long nativePtr, int sizeInBytes)

Factory method to create the AnimatedImage from the

Parameters
nativePtr The native pointer
sizeInBytes The size in byte to allocate
Returns
  • The AnimatedImage allocation

public void dispose ()

Disposes the instance. This will free native resources held by this instance. Once called, other methods on this instance may throw. Note, the underlying native resources may not actually be freed until all associated instances of AnimatedImageFrame are disposed or finalized as well.

public boolean doesRenderSupportScaling ()

Returns whether renderFrame(int, int, Bitmap) supports scaling to arbitrary sizes or whether scaling must be done externally.

Returns
  • whether rendering supports scaling

public int getDuration ()

Gets the duration of the animated image.

Returns
  • the duration of the animated image in milliseconds

public WebPFrame getFrame (int frameNumber)

Creates an AnimatedImageFrame at the specified index.

Parameters
frameNumber the index of the frame
Returns

public int getFrameCount ()

Gets the number of frames in the image.

Returns
  • the number of frames in the image

public int[] getFrameDurations ()

Gets the duration of each frame of the animated image.

Returns
  • an array that is the size of the number of frames containing the duration of each frame in milliseconds

public AnimatedDrawableFrameInfo getFrameInfo (int frameNumber)

Gets the frame info for the specified frame.

Parameters
frameNumber the frame to get the info for
Returns
  • the frame info

public int getHeight ()

Gets the height of the image (also known as the canvas in WebP nomenclature).

Returns
  • the height of the image

public int getLoopCount ()

Gets the number of loops to run the animation for.

Returns
  • the number of loops, or 0 to indicate infinite

public int getSizeInBytes ()

Gets the size of bytes of the encoded image data (which is the data kept in memory for the image).

Returns
  • the size in bytes of the encoded image data

public int getWidth ()

Gets the width of the image (also known as the canvas in WebP nomenclature).

Returns
  • the width of the image

Protected Methods

protected void finalize ()