- checkArgument(boolean) - Static method in class com.facebook.spectrum.utils.Preconditions
-
Asserts that the given assertion about an argument is true.
- checkNotNull(T) - Static method in class com.facebook.spectrum.utils.Preconditions
-
Asserts that the given reference is not null.
- checkState(boolean) - Static method in class com.facebook.spectrum.utils.Preconditions
-
Asserts that the given assertion about a state is true.
- chromaSamplingMode - Variable in class com.facebook.spectrum.image.ImageSpecification
-
- chromaSamplingModeOverride - Variable in class com.facebook.spectrum.Configuration
-
- close() - Method in class com.facebook.spectrum.EncodedImageSink
-
- close() - Method in class com.facebook.spectrum.EncodedImageSource
-
- colorModel - Variable in enum com.facebook.spectrum.image.ImagePixelSpecification
-
Number of color components and how to interpret them
- com.facebook.spectrum - package com.facebook.spectrum
-
- com.facebook.spectrum.image - package com.facebook.spectrum.image
-
- com.facebook.spectrum.logging - package com.facebook.spectrum.logging
-
- com.facebook.spectrum.options - package com.facebook.spectrum.options
-
- com.facebook.spectrum.plugins - package com.facebook.spectrum.plugins
-
- com.facebook.spectrum.requirements - package com.facebook.spectrum.requirements
-
- com.facebook.spectrum.utils - package com.facebook.spectrum.utils
-
- componentsOrder - Variable in enum com.facebook.spectrum.image.ImagePixelSpecification
-
Order of the components in memory representation .
- Configuration - Class in com.facebook.spectrum
-
The Configuration class defines configuration parameters that can be used to tweak low level
options of how an operation is performed.
- configuration - Variable in class com.facebook.spectrum.options.Options.Builder
-
- configuration(Configuration) - Method in class com.facebook.spectrum.options.Options.Builder
-
Options in the configuration object will override default and app-wide settings.
- configuration - Variable in class com.facebook.spectrum.options.Options
-
Options in the configuration object will override default and app-wide settings.
- Configuration.Builder - Class in com.facebook.spectrum
-
- Configuration.ImageHint - Enum in com.facebook.spectrum
-
Optional hint when encoding WebP images
- Configuration.SamplingMethod - Enum in com.facebook.spectrum
-
Sampling algorithms for the exact resize block
- createBitmapArgb(int, int) - Method in class com.facebook.spectrum.BitmapTarget
-
Allocates a bitmap with the given width, height, and Bitmap.Config#ARGB_8888.
- createPlugin() - Method in class com.facebook.spectrum.plugins.SpectrumPlugin
-
Creates a new native plugin on the heap and returns a raw pointer
- crop(CropRequirement) - Method in class com.facebook.spectrum.options.Options.Builder
-
The crop requirement to apply.
- cropAbsoluteToOrigin(int, int, int, int, boolean) - Method in class com.facebook.spectrum.options.Options.Builder
-
The crop requirement to apply.
- cropRelativeToOrigin(float, float, float, float, boolean) - Method in class com.facebook.spectrum.options.Options.Builder
-
The crop requirement to apply.
- cropRequirement - Variable in class com.facebook.spectrum.options.Options.Builder
-
- cropRequirement - Variable in class com.facebook.spectrum.options.Transformations
-
- CropRequirement - Class in com.facebook.spectrum.requirements
-
Defines how an image should be cropped.
- getBitmap() - Method in class com.facebook.spectrum.BitmapTarget
-
- getDescription() - Method in exception com.facebook.spectrum.SpectrumException
-
Additional verbose descriptions (e.g.
- getInputImageSpecification() - Method in class com.facebook.spectrum.SpectrumResult
-
Detected input image specification for the operation.
- getInputStream() - Method in class com.facebook.spectrum.EncodedImageSource
-
Returns the underlying InputStream
- getLocation() - Method in exception com.facebook.spectrum.SpectrumException
-
The location of the error including method and line number
- getMessage() - Method in exception com.facebook.spectrum.SpectrumException
-
The specific error message (e.g.
- getName() - Method in exception com.facebook.spectrum.SpectrumException
-
Name that groups similar exceptions together (e.g.
- getOutputImageSpecification() - Method in class com.facebook.spectrum.SpectrumResult
-
Determined output image specification for the operation.
- getOutputStream() - Method in class com.facebook.spectrum.EncodedImageSink
-
Returns the underlying OutputStream
- getPlugin() - Method in class com.facebook.spectrum.plugins.SpectrumPlugin
-
Creates a new native instance of the plugin.
- getRuleName() - Method in class com.facebook.spectrum.SpectrumResult
-
Name of the rule which has performed the operation.
- getTotalBytesRead() - Method in class com.facebook.spectrum.SpectrumResult
-
Total number of bytes that has been read from the underlying image source
- getTotalBytesWritten() - Method in class com.facebook.spectrum.SpectrumResult
-
Total number of bytes that has been written to the image sink
- GIF - Static variable in class com.facebook.spectrum.image.EncodedImageFormat
-
A GIF encoded image, see https://en.wikipedia.org/wiki/GIF
- green - Variable in class com.facebook.spectrum.image.ImageColor
-
- identifier - Variable in class com.facebook.spectrum.image.ImageFormat
-
- ImageChromaSamplingMode - Enum in com.facebook.spectrum.image
-
Chroma sampling describe the number of luma information per chroma information.
- ImageColor - Class in com.facebook.spectrum.image
-
Representation of an RGB color information.
- ImageColor(int, int, int) - Constructor for class com.facebook.spectrum.image.ImageColor
-
- ImageFormat - Class in com.facebook.spectrum.image
-
Represents an image format.
- ImageFormat(String) - Constructor for class com.facebook.spectrum.image.ImageFormat
-
- ImageMetadata - Class in com.facebook.spectrum.image
-
Metadata represents information that is stored in images beside their pixel values.
- ImageMetadata() - Constructor for class com.facebook.spectrum.image.ImageMetadata
-
- ImageOrientation - Enum in com.facebook.spectrum.image
-
The orientation describes the transformation that needs to be applied to the underlying image in
order to reach its intended representation.
- ImagePixelSpecification - Enum in com.facebook.spectrum.image
-
The specification explains how pixels and the color information is stored as a continuous stream
of bytes.
- ImageSize - Class in com.facebook.spectrum.image
-
Represents a rectangular area defined by its width and height.
- ImageSize(int, int) - Constructor for class com.facebook.spectrum.image.ImageSize
-
- ImageSpecification - Class in com.facebook.spectrum.image
-
An image's specification contains all derived and extracted information besides the pixel
content.
- ImageSpecification(ImageSize, ImageFormat, ImagePixelSpecification) - Constructor for class com.facebook.spectrum.image.ImageSpecification
-
Constructor for an image specification with default orientation, no sampling and empty
metadata.
- ImageSpecification(ImageSize, ImageFormat, ImagePixelSpecification, ImageOrientation, ImageChromaSamplingMode, ImageMetadata) - Constructor for class com.facebook.spectrum.image.ImageSpecification
-
- init(Context) - Static method in class com.facebook.spectrum.SpectrumSoLoader
-
Initializes the SoLoader library.
- interpretMetadata - Variable in class com.facebook.spectrum.Configuration
-
General: Whether to read and interpret metadata such as EXIF for JPEG files.
- isAvailable() - Method in class com.facebook.spectrum.Spectrum
-
- isAvailable() - Method in class com.facebook.spectrum.SpectrumHybrid
-
Returns true if the native library is loaded and initialized properly.
- isEncoded() - Method in class com.facebook.spectrum.image.EncodedImageFormat
-
- isEncoded() - Method in class com.facebook.spectrum.image.ImageFormat
-
- isImageFormatSupported(ImageFormat) - Method in class com.facebook.spectrum.Spectrum
-
This method indicates whether the given image format is supported by Spectrum using the default
plugin.
- isSuccessful() - Method in class com.facebook.spectrum.SpectrumResult
-
True iff a rule has been applied to fulfill the request
- samplingMethod - Variable in class com.facebook.spectrum.Configuration
-
General: The sampling mode to use when scaling the image.
- setChromaSamplingModeOverride(ImageChromaSamplingMode) - Method in class com.facebook.spectrum.Configuration.Builder
-
- setDefaultBackgroundColor(ImageColor) - Method in class com.facebook.spectrum.Configuration.Builder
-
General: Default background color to merge transparent images onto.
- setInterpretMetadata(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
General: Whether to read and interpret metadata such as EXIF for JPEG files.
- setPropagateChromaSamplingModeFromSource(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
General: Whether to propagate chroma sampling mode from the source image.
- setSamplingMethod(Configuration.SamplingMethod) - Method in class com.facebook.spectrum.Configuration.Builder
-
General: The sampling algorithm to use for the scale operation.
- setUseCompatibleDcScanOpt(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Jpeg: Whether to use compatible DC scan configuration (keeping all DC components in the first
scan) when encoding JPEG images.
- setUseInterlacing(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Png: Whether to save PNG images with interlaced encoding.
- setUseOptimizeScan(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Jpeg: Whether to use scan optimization when encoding JPEG images.
- setUseProgressive(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Jpeg: Whether to save JPEG images in progressive scan encoding.
- setUsePsnrQuantTable(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Jpeg: Whether to use an alternative quantization table optimized for PSNR when encoding JPEG
images.
- setUseTrellis(Boolean) - Method in class com.facebook.spectrum.Configuration.Builder
-
Jpeg: Whether to use trellis optimization when encoding JPEG images.
- setWebpImageHint(Configuration.ImageHint) - Method in class com.facebook.spectrum.Configuration.Builder
-
- setWebpMethod(Integer) - Method in class com.facebook.spectrum.Configuration.Builder
-
Webp: Compression quality/speed tradeoff where 0 is the fastest and 6 is the slowest/best
compression.
- size - Variable in class com.facebook.spectrum.image.ImageSpecification
-
- Spectrum - Class in com.facebook.spectrum
-
The
Spectrum class provides access to the
Spectrum.decode(com.facebook.spectrum.EncodedImageSource, com.facebook.spectrum.BitmapTarget, com.facebook.spectrum.options.DecodeOptions, java.lang.Object),
Spectrum.encode(android.graphics.Bitmap, com.facebook.spectrum.EncodedImageSink, com.facebook.spectrum.options.EncodeOptions, java.lang.Object),
Spectrum.transcode(com.facebook.spectrum.EncodedImageSource, com.facebook.spectrum.EncodedImageSink, com.facebook.spectrum.options.TranscodeOptions, java.lang.Object), and
Spectrum.transform(android.graphics.Bitmap, com.facebook.spectrum.BitmapTarget, com.facebook.spectrum.options.TransformOptions, java.lang.Object) operations.
- SpectrumException - Exception in com.facebook.spectrum
-
Thrown when the request was unable to be fulfilled by Spectrum.
- SpectrumException(String) - Constructor for exception com.facebook.spectrum.SpectrumException
-
Creates new exception with the given message
- SpectrumException(Exception) - Constructor for exception com.facebook.spectrum.SpectrumException
-
Creates new exception with the given cause
- SpectrumException(String, Exception) - Constructor for exception com.facebook.spectrum.SpectrumException
-
Creates new exception with the given message and cause
- SpectrumHybrid - Class in com.facebook.spectrum
-
Internal object that maintains the state of the native implementation and controls the JNI
interaction.
- SpectrumHybrid(Configuration, SpectrumPlugin[]) - Constructor for class com.facebook.spectrum.SpectrumHybrid
-
- SpectrumLogcatLogger - Class in com.facebook.spectrum.logging
-
Simple implementation of
SpectrumLogger which logs to Android's main log using
Log.
- SpectrumLogcatLogger() - Constructor for class com.facebook.spectrum.logging.SpectrumLogcatLogger
-
Creates a new LogcatLogger that informative messages logs at level Log.DEBUG and error
messages at level Log.WARN.
- SpectrumLogcatLogger(int) - Constructor for class com.facebook.spectrum.logging.SpectrumLogcatLogger
-
Creates a new LogcatLogger with the given log level for informational messages.
- SpectrumLogcatLogger(int, int) - Constructor for class com.facebook.spectrum.logging.SpectrumLogcatLogger
-
Creates a new LogcatLogger with the given log and error level
- SpectrumLogger - Interface in com.facebook.spectrum.logging
-
The interface to be implemented by the global logger for Spectrum events which are emitted for
all requests.
- SpectrumPlugin - Class in com.facebook.spectrum.plugins
-
Common plugin interface that allow aggregating native plugin creation methods between modules.
- SpectrumPlugin() - Constructor for class com.facebook.spectrum.plugins.SpectrumPlugin
-
- SpectrumResult - Class in com.facebook.spectrum
-
A Result encapsulates information about the operation (e.g.
- SpectrumResult(String, ImageSpecification, ImageSpecification, long, long) - Constructor for class com.facebook.spectrum.SpectrumResult
-
- SpectrumSoLoader - Class in com.facebook.spectrum
-
Helper class for initializing the SoLoader library (see https://github.com/facebook/SoLoader).
- SpectrumSoLoader() - Constructor for class com.facebook.spectrum.SpectrumSoLoader
-
- value - Variable in enum com.facebook.spectrum.image.ImageChromaSamplingMode
-
- value - Variable in enum com.facebook.spectrum.image.ImageOrientation
-
- valueOf(String) - Static method in enum com.facebook.spectrum.Configuration.ImageHint
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.Configuration.SamplingMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.image.ImageChromaSamplingMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.image.ImageOrientation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.image.ImagePixelSpecification
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.requirements.EncodeRequirement.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.facebook.spectrum.requirements.ResizeRequirement.Mode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.facebook.spectrum.Configuration.ImageHint
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.Configuration.SamplingMethod
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.image.ImageChromaSamplingMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.image.ImageOrientation
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.image.ImagePixelSpecification
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.requirements.EncodeRequirement.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.facebook.spectrum.requirements.ResizeRequirement.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.