public class

ImageDecodeOptionsBuilder

extends Object
java.lang.Object
   ↳ com.facebook.imagepipeline.common.ImageDecodeOptionsBuilder

Class Overview

Builder for ImageDecodeOptions.

Summary

Public Constructors
ImageDecodeOptionsBuilder()
Public Methods
ImageDecodeOptions build()
Builds the immutable ImageDecodeOptions instance.
Bitmap.Config getBitmapConfig()
Gets which config image will be decode with;
ImageDecoder getCustomImageDecoder()
Get the custom image decoder, if one has been set.
boolean getDecodeAllFrames()
Gets whether to decode all the frames and store them in memory.
boolean getDecodePreviewFrame()
Gets whether to decode a preview frame for animated images.
boolean getForceStaticImage()
Gets whether to force animated image formats to be decoded as static, non-animated images.
int getMinDecodeIntervalMs()
Gets the minimum decode interval.
boolean getUseLastFrameForPreview()
Gets whether to use the last frame for the preview image (defaults to the first frame).
void setBitmapConfig(Bitmap.Config bitmapConfig)
Sets which config static image will be decode with;
ImageDecodeOptionsBuilder setCustomImageDecoder(ImageDecoder customImageDecoder)
Set a custom image decoder override to be used for the given image.
ImageDecodeOptionsBuilder setDecodeAllFrames(boolean decodeAllFrames)
Sets whether to decode all the frames and store them in memory.
ImageDecodeOptionsBuilder setDecodePreviewFrame(boolean decodePreviewFrame)
Sets whether to decode a preview frame for animated images.
ImageDecodeOptionsBuilder setForceStaticImage(boolean forceStaticImage)
Sets whether to force animated image formats to be decoded as static, non-animated images.
ImageDecodeOptionsBuilder setFrom(ImageDecodeOptions options)
Sets the builder to be equivalent to the specified options.
ImageDecodeOptionsBuilder setMinDecodeIntervalMs(int intervalMs)
Sets the minimum decode interval.
ImageDecodeOptionsBuilder setUseLastFrameForPreview(boolean useLastFrameForPreview)
Sets whether to use the last frame for the preview image (defaults to the first frame).
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ImageDecodeOptionsBuilder ()

Public Methods

public ImageDecodeOptions build ()

Builds the immutable ImageDecodeOptions instance.

Returns
  • the immutable instance

public Bitmap.Config getBitmapConfig ()

Gets which config image will be decode with;

Returns
  • which config image will be decode with

public ImageDecoder getCustomImageDecoder ()

Get the custom image decoder, if one has been set.

Returns
  • the custom image decoder or null if not set

public boolean getDecodeAllFrames ()

Gets whether to decode all the frames and store them in memory. This should only ever be used for animations that are known to be small (e.g. stickers). Caching dozens of large Bitmaps in memory for general GIFs or WebP's will not fit in memory.

Returns
  • whether to decode all the frames and store them in memory

public boolean getDecodePreviewFrame ()

Gets whether to decode a preview frame for animated images.

Returns
  • whether to decode a preview frame

public boolean getForceStaticImage ()

Gets whether to force animated image formats to be decoded as static, non-animated images.

Returns
  • whether to force animated image formats to be decoded as static

public int getMinDecodeIntervalMs ()

Gets the minimum decode interval.

Returns
  • the minimum decode interval in milliseconds

public boolean getUseLastFrameForPreview ()

Gets whether to use the last frame for the preview image (defaults to the first frame).

Returns
  • whether to use the last frame for the preview image

public void setBitmapConfig (Bitmap.Config bitmapConfig)

Sets which config static image will be decode with;

Parameters
bitmapConfig which config static image will be decode with;

public ImageDecodeOptionsBuilder setCustomImageDecoder (ImageDecoder customImageDecoder)

Set a custom image decoder override to be used for the given image. This will bypass all default decoders and only use the provided custom image decoder for the given image.

Parameters
customImageDecoder the custom decoder to use
Returns
  • this builder

public ImageDecodeOptionsBuilder setDecodeAllFrames (boolean decodeAllFrames)

Sets whether to decode all the frames and store them in memory. This should only ever be used for animations that are known to be small (e.g. stickers). Caching dozens of large Bitmaps in memory for general GIFs or WebP's will not fit in memory.

Parameters
decodeAllFrames whether to decode all the frames and store them in memory
Returns
  • this builder

public ImageDecodeOptionsBuilder setDecodePreviewFrame (boolean decodePreviewFrame)

Sets whether to decode a preview frame for animated images.

Parameters
decodePreviewFrame whether to decode a preview frame
Returns
  • this builder

public ImageDecodeOptionsBuilder setForceStaticImage (boolean forceStaticImage)

Sets whether to force animated image formats to be decoded as static, non-animated images.

Parameters
forceStaticImage whether to force the image to be decoded as a static image
Returns
  • this builder

public ImageDecodeOptionsBuilder setFrom (ImageDecodeOptions options)

Sets the builder to be equivalent to the specified options.

Parameters
options the options to copy from
Returns
  • this builder

public ImageDecodeOptionsBuilder setMinDecodeIntervalMs (int intervalMs)

Sets the minimum decode interval.

Decoding of intermediate results won't happen more often that intervalMs. If another intermediate result comes too soon, it will be decoded only after intervalMs since the last decode. If there were more intermediate results in between, only the last one gets decoded.

Parameters
intervalMs the minimum decode interval in milliseconds
Returns
  • this builder

public ImageDecodeOptionsBuilder setUseLastFrameForPreview (boolean useLastFrameForPreview)

Sets whether to use the last frame for the preview image (defaults to the first frame).

Parameters
useLastFrameForPreview whether to use the last frame for the preview image
Returns
  • this builder