com.facebook.spectrum

Class Spectrum

java.lang.Object

com.facebook.spectrum.Spectrum

public class Spectrum
extends java.lang.Object

The Spectrum class provides access to the decode(com.facebook.spectrum.EncodedImageSource, com.facebook.spectrum.BitmapTarget, com.facebook.spectrum.options.DecodeOptions, java.lang.Object), encode(android.graphics.Bitmap, com.facebook.spectrum.EncodedImageSink, com.facebook.spectrum.options.EncodeOptions, java.lang.Object), transcode(com.facebook.spectrum.EncodedImageSource, com.facebook.spectrum.EncodedImageSink, com.facebook.spectrum.options.TranscodeOptions, java.lang.Object), and transform(android.graphics.Bitmap, com.facebook.spectrum.BitmapTarget, com.facebook.spectrum.options.TransformOptions, java.lang.Object) operations.

Once created, a Spectrum object is thread-safe in respect to the executed operations. If ised repeatedly, consider retaining an instance around in your application.

Method Summary

Modifier and Type	Method and Description
SpectrumResult	decode(EncodedImageSource source, BitmapTarget bitmapTarget, DecodeOptions decodeOptions, java.lang.Object callerContext) A decode operation reads an encoded image and creates a bitmap.
SpectrumResult	encode(android.graphics.Bitmap bitmap, EncodedImageSink sink, EncodeOptions encodeOptions, java.lang.Object callerContext) An encode operation reads a bitmap and creates an encoded image.
boolean	isAvailable()
boolean	isImageFormatSupported(ImageFormat imageFormat) This method indicates whether the given image format is supported by Spectrum using the default plugin.
static Spectrum	make(SpectrumLogger spectrumLogger, Configuration configuration, SpectrumPlugin... plugins) Creates a new Spectrum with the given SpectrumLogger, global Configuration, and the given SpectrumPlugins.
static Spectrum	make(SpectrumLogger spectrumLogger, SpectrumPlugin[] plugins) Creates a new Spectrum with the given SpectrumLogger and the given SpectrumPlugins.
SpectrumResult	transcode(EncodedImageSource source, EncodedImageSink sink, TranscodeOptions transcodeOptions, java.lang.Object callerContext) A transcode operation reads an encoded image and creates an encoded image.
SpectrumResult	transform(android.graphics.Bitmap bitmap, BitmapTarget bitmapTarget, TransformOptions transformOptions, java.lang.Object callerContext) A transform operation reads a bitmap and creates a bitmap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

make

public static Spectrum make(SpectrumLogger spectrumLogger,
                            SpectrumPlugin[] plugins)

Creates a new Spectrum with the given SpectrumLogger and the given SpectrumPlugins. A default Configuration is used.

make

public static Spectrum make(SpectrumLogger spectrumLogger,
                            Configuration configuration,
                            SpectrumPlugin... plugins)

Creates a new Spectrum with the given SpectrumLogger, global Configuration, and the given SpectrumPlugins.

isAvailable

public boolean isAvailable()

Returns:

true iff the native code loaded and initialized properly.

decode

public SpectrumResult decode(EncodedImageSource source,
                             BitmapTarget bitmapTarget,
                             DecodeOptions decodeOptions,
                             java.lang.Object callerContext)
                      throws SpectrumException

A decode operation reads an encoded image and creates a bitmap.

Parameters:

source - The EncodedImageSource to read from.

bitmapTarget - The BitmapTarget to create and retain the created bitmap.

decodeOptions - The DecodeOptions for this operation.

callerContext - The caller context that identifies this particular call site.

Returns:

SpectrumResult containing information about the execution.

Throws:

SpectrumException - for invalid input, missing support and runtime errors.

encode

public SpectrumResult encode(android.graphics.Bitmap bitmap,
                             EncodedImageSink sink,
                             EncodeOptions encodeOptions,
                             java.lang.Object callerContext)
                      throws SpectrumException

An encode operation reads a bitmap and creates an encoded image.

Parameters:

bitmap - The Bitmap to read from.

sink - The EncodedImageSink to write the encoded image to.

encodeOptions - The EncodeOptions for this operation.

callerContext - The caller context that identifies this particular call site.

Returns:

SpectrumResult containing information about the execution.

Throws:

SpectrumException - for invalid input, missing support and runtime errors.

transcode

public SpectrumResult transcode(EncodedImageSource source,
                                EncodedImageSink sink,
                                TranscodeOptions transcodeOptions,
                                java.lang.Object callerContext)
                         throws SpectrumException

A transcode operation reads an encoded image and creates an encoded image.

Parameters:

source - The EncodedImageSource to read from.

sink - The EncodedImageSink to write the encoded image to.

transcodeOptions - The TranscodeOptions for this operation.

callerContext - The caller context that identifies this particular call site.

Returns:

SpectrumResult containing information about the execution.

Throws:

SpectrumException - for invalid input, missing support and runtime errors.

transform

public SpectrumResult transform(android.graphics.Bitmap bitmap,
                                BitmapTarget bitmapTarget,
                                TransformOptions transformOptions,
                                java.lang.Object callerContext)
                         throws SpectrumException

A transform operation reads a bitmap and creates a bitmap.

Parameters:

bitmap - The Bitmap to read from

bitmapTarget - The BitmapTarget to create and retain the created bitmap.

transformOptions - The TransformOptions for this operation.

callerContext - The caller context that identifies this particular call site.

Returns:

SpectrumResult containing information about the execution.

Throws:

SpectrumException - for invalid input, missing support and runtime errors.

isImageFormatSupported

public boolean isImageFormatSupported(ImageFormat imageFormat)

This method indicates whether the given image format is supported by Spectrum using the default plugin.