Module: google.appengine.api.images

Image manipulation API.

App Engine provides the ability to manipulate image data using a dedicated Images service. The Images service can resize, rotate, flip, and crop images; it can composite multiple images into a single image; and it can convert image data between several formats. It can also enhance photographs using a predefined algorithm. The API can also provide information about an image, such as its format, width, height, and a histogram of color values.

Modules

images_blob_stub module: Stub version of the blob-related parts of the images API.

images_stub module: Stub version of the images API.

Classes

class AccessDeniedError: The application does not have permission to access the image.

class BadImageError: The image data is corrupt.

class BlobKeyRequiredError: A blob key is required for this operation.

class Error: Base error class for this module.

class Image: Image object to manipulate.

class InvalidBlobKeyError: The provided blob key was invalid.

class LargeImageError: The image data is too large to process.

class NotImageError: The image data given is not recognizable as an image.

class ObjectNotFoundError: The blob key referred to an object that does not exist.

class TransformationError: An error occurred while attempting to transform the image.

class UnsupportedSizeError: The size that was specified is not supported by requested operation.

Functions

composite(...): Composites one or more images onto a canvas.

composite_async(...): Asynchronously composites one or more images onto a canvas.

create_rpc(...): Creates an RPC object for use with the Images API.

crop(...): Crops the image.

crop_async(...): Asynchronously crops the given image.

delete_serving_url(...): Deletes a serving URL created for blob_key using get_serving_url.

delete_serving_url_async(...): Deletes a serving URL created using get_serving_url - async version.

get_serving_url(...): Obtains a URL that will serve the underlying image.

get_serving_url_async(...): Asynchronously obtains a URL that will serve the underlying image.

histogram(...): Calculates the histogram of the given image.

histogram_async(...): Calculates the histogram of the given image - async version.

horizontal_flip(...): Flips the image horizontally.

horizontal_flip_async(...): Asynchronously flips the image horizontally.

im_feeling_lucky(...): Automatically adjusts image levels.

im_feeling_lucky_async(...): Asynchronously automatically adjusts image levels.

resize(...): Resizes a given image file while maintaining the aspect ratio.

resize_async(...): Asynchronously resizes an image file, maintaining the aspect ratio.

rotate(...): Rotates an image a given number of degrees clockwise.

rotate_async(...): Asynchronously rotates an image a specified number of degrees clockwise.

vertical_flip(...): Flips the image vertically.

vertical_flip_async(...): Asynchronously flips the image vertically.

ANCHOR_TYPES

{
 0,
 1,
 2,
 3,
 4,
 5,
 6,
 7,
 8
}

BMP -1
BOTTOM_CENTER 7
BOTTOM_LEFT 6
BOTTOM_RIGHT 8
CENTER_CENTER 4
CENTER_LEFT 3
CENTER_RIGHT 5
CORRECT_ORIENTATION 1
GIF -2
ICO -3
IMG_SERVING_CROP_SIZES [32, 48, 64, 72, 80, 104, 136, 144, 150, 160]
IMG_SERVING_SIZES [32, 48, 64, 72, 80, 90, 94, 104, 110, 120, 128, 144, 150, 160, 200, 220, 288, 320, 400, 512, 576, 640, 720, 800, 912, 1024, 1152, 1280, 1440, 1600]
IMG_SERVING_SIZES_LIMIT 3200
JPEG 1
MAX_COMPOSITES_PER_REQUEST 16
MAX_TRANSFORMS_PER_REQUEST 10
ORIENTATION_CORRECTION_TYPE

{
 0,
 1
}

OUTPUT_ENCODING_TYPES

{
 0,
 1,
 2
}

PNG 0
TIFF -4
TOP_CENTER 1
TOP_LEFT 0
TOP_RIGHT 2
UNCHANGED_ORIENTATION 0
WEBP 2