Provides facilities for the creation and manipulation of images. The starting point is the com.google.appengine.api.images.ImagesServiceFactory class, which can produce the com.google.appengine.api.images.ImagesService, but also the basic com.google.appengine.api.images.Image object and com.google.appengine.api.images.Transform classes. More information is available in the on-line documentation.
Image data is represented as a byte[] of data, in any of the supported formats: JPEG,
PNG, GIF (including animated GIF), BMP, TIFF, and ICO formats. The format can be accessed via the
com.google.appengine.api.images.Image#getFormat() method. The image format may be
converted during transformation.
Supported transformations include cropping, resizing, rotating in 90-degree increments, horizontal and vertical flips, and automated color enhancement. See Also: The Images Java API in the Google App Engine Developer's Guide., com.google.appengine.api.images.ImagesService
Classes
Composite
A Composite represents a composition of an image onto a canvas.
CompositeTransform
A transform that represents zero or more transforms executed in series.
IImagesServiceFactoryProvider
Factory provider for IImagesServiceFactory.
Note: This class is not intended for end users.
ImagesServiceFactory
Factory for creating an ImagesService, Images and Transforms.
ImagesServicePb
ImagesServicePb.CompositeImageOptions
ImagesServicePb.CompositeImageOptions.Builder
ImagesServicePb.ImageData
ImagesServicePb.ImageData.Builder
ImagesServicePb.ImagesCanvas
ImagesServicePb.ImagesCanvas.Builder
ImagesServicePb.ImagesCompositeRequest
ImagesServicePb.ImagesCompositeRequest.Builder
ImagesServicePb.ImagesCompositeResponse
ImagesServicePb.ImagesCompositeResponse.Builder
ImagesServicePb.ImagesDeleteUrlBaseRequest
ImagesServicePb.ImagesDeleteUrlBaseRequest.Builder
ImagesServicePb.ImagesDeleteUrlBaseResponse
ImagesServicePb.ImagesDeleteUrlBaseResponse.Builder
ImagesServicePb.ImagesGetUrlBaseRequest
ImagesServicePb.ImagesGetUrlBaseRequest.Builder
ImagesServicePb.ImagesGetUrlBaseResponse
ImagesServicePb.ImagesGetUrlBaseResponse.Builder
ImagesServicePb.ImagesHistogram
ImagesServicePb.ImagesHistogram.Builder
ImagesServicePb.ImagesHistogramRequest
ImagesServicePb.ImagesHistogramRequest.Builder
ImagesServicePb.ImagesHistogramResponse
ImagesServicePb.ImagesHistogramResponse.Builder
ImagesServicePb.ImagesServiceError
ImagesServicePb.ImagesServiceError.Builder
ImagesServicePb.ImagesServiceTransform
ImagesServicePb.ImagesServiceTransform.Builder
ImagesServicePb.ImagesTransformRequest
ImagesServicePb.ImagesTransformRequest.Builder
ImagesServicePb.ImagesTransformResponse
ImagesServicePb.ImagesTransformResponse.Builder
ImagesServicePb.InputSettings
ImagesServicePb.InputSettings.Builder
ImagesServicePb.OutputSettings
ImagesServicePb.OutputSettings.Builder
ImagesServicePb.Transform
ImagesServicePb.Transform.Builder
InputSettings
InputSettings represents the different settings to specify how
an Image is interpreted by a transform.
OutputSettings
OutputSettings represents the different settings to specify how
a particular transform or composite will return an Image.
ServingUrlOptions
Allow users to customize the behavior of creating a image serving URL using the ImagesService.
ServingUrlOptions.Builder
Contains static creation methods for ServingUrlOptions.
Transform
A transform that can be applied to an Image.
Interfaces
IImagesServiceFactory
Factory for creating an ImagesService, Images and Transforms.
Image
Image represents an image that can be manipulated by the
ImagesService.
ImagesService
The images service provides methods to apply transformations to images.
ImagesServicePb.CompositeImageOptionsOrBuilder
ImagesServicePb.ImageDataOrBuilder
ImagesServicePb.ImagesCanvasOrBuilder
ImagesServicePb.ImagesCompositeRequestOrBuilder
ImagesServicePb.ImagesCompositeResponseOrBuilder
ImagesServicePb.ImagesDeleteUrlBaseRequestOrBuilder
ImagesServicePb.ImagesDeleteUrlBaseResponseOrBuilder
ImagesServicePb.ImagesGetUrlBaseRequestOrBuilder
ImagesServicePb.ImagesGetUrlBaseResponseOrBuilder
ImagesServicePb.ImagesHistogramOrBuilder
ImagesServicePb.ImagesHistogramRequestOrBuilder
ImagesServicePb.ImagesHistogramResponseOrBuilder
ImagesServicePb.ImagesServiceErrorOrBuilder
ImagesServicePb.ImagesServiceTransformOrBuilder
ImagesServicePb.ImagesTransformRequestOrBuilder
ImagesServicePb.ImagesTransformResponseOrBuilder
ImagesServicePb.InputSettingsOrBuilder
ImagesServicePb.OutputSettingsOrBuilder
ImagesServicePb.TransformOrBuilder
Enums
Composite.Anchor
Valid anchoring positions for a compositing operation. The anchor position of the image is aligned with the anchor position of the canvas.
Image.Format
Image formats usable by the images api.
ImagesService.OutputEncoding
Valid output encoding formats usable for image transforms. See Also: PNG Image Format., JPEG Image Format., WEBP Image Format.
ImagesServicePb.CompositeImageOptions.ANCHOR
ImagesServicePb.ImagesServiceError.ErrorCode
ImagesServicePb.ImagesServiceTransform.Type
ImagesServicePb.InputSettings.ORIENTATION_CORRECTION_TYPE
ImagesServicePb.OutputSettings.MIME_TYPE
InputSettings.OrientationCorrection
Actions to take with respect to correcting image orientation based on image metadata. EXIF metadata within the image may contain a parameter indicating its proper orientation. This value can equal 1 through 8, inclusive. "1" means that the image is in its "normal" orientation, i.e., it should be viewed as it is stored.
Regardless of the OrientationCorrection value used, the
orientation value in a transformed image is always cleared to indicate that
no additional corrections of the returned image's orientation is necessary.
Exceptions
ImagesServiceFailureException
ImagesServiceFailureException is thrown when any unknown
error occurs while communicating with the images service.