ImagesService (Google App Engine API for Java)

com.google.appengine.api.images

Interface ImagesService



  • public interface ImagesService
    The images service provides methods to apply transformations to images.
    • Field Detail

      • MAX_TRANSFORMS_PER_REQUEST

        static final int MAX_TRANSFORMS_PER_REQUEST
        See Also:
        Constant Field Values
      • MAX_COMPOSITES_PER_REQUEST

        static final int MAX_COMPOSITES_PER_REQUEST
        See Also:
        Constant Field Values
      • SERVING_SIZES

        @Deprecated
        static final java.util.Set<java.lang.Integer> SERVING_SIZES
        Deprecated. 
      • SERVING_CROP_SIZES

        @Deprecated
        static final java.util.Set<java.lang.Integer> SERVING_CROP_SIZES
        Deprecated. 
    • Method Detail

      • applyTransform

        Image applyTransform(Transform transform,
                             Image image)
        Applies the provided transform to the provided image encoding the transformed image stored using PNG file format. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        Returns:
        transformed image
        Throws:
        java.lang.IllegalArgumentException - If transform or image are invalid.
        ImagesServiceFailureException - If there is a problem with the Images Service
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image)
        Asynchronously applies the provided transform to the provided image encoding the transformed image stored using PNG file format. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        Returns:
        A future containing the transformed image or one of the exceptions documented for applyTransform(Transform, Image).
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             ImagesService.OutputEncoding encoding)
        Applies the provided transform to the provided image encoding the transformed image stored using encoding file format. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        encoding - output encoding to be used
        Returns:
        transformed image
        Throws:
        java.lang.IllegalArgumentException - If transform, image or encoding are invalid.
        ImagesServiceFailureException - If there is a problem with the Images Service
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               ImagesService.OutputEncoding encoding)
        Asynchronously applies the provided transform to the provided image encoding the transformed image stored using encoding file format. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        encoding - output encoding to be used
        Returns:
        A future containing the transformed image or one of the exceptions documented for applyTransform(Transform, Image, OutputEncoding).
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             OutputSettings settings)
        Applies the provided transform to the provided image encoding the transformed image stored using settings. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        settings - output settings to be used
        Returns:
        transformed image
        Throws:
        java.lang.IllegalArgumentException - If transform, image or settings are invalid.
        ImagesServiceFailureException - If there is a problem with the Images Service
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               OutputSettings settings)
        Asynchronously applies the provided transform to the provided image encoding the transformed image stored using settings. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        settings - output settings to be used
        Returns:
        A future containing the transformed image or one of the exceptions documented for applyTransform(Transform, Image, OutputSettings).
      • applyTransform

        Image applyTransform(Transform transform,
                             Image image,
                             InputSettings inputSettings,
                             OutputSettings outputSettings)
        Applies the provided transform to the provided image encoding the transformed image stored using outputSettings interpreting image according to inputSettings. The transform is applied in place to the provided image.
        Parameters:
        transform - transform to be applied
        image - image to be transformed
        inputSettings - input settings to be used
        outputSettings - output settings to be used
        Returns:
        transformed image
        Throws:
        java.lang.IllegalArgumentException - If transform, image, inputSettings or outputSettings are invalid.
        ImagesServiceFailureException - If there is a problem with the Images Service
      • applyTransformAsync

        java.util.concurrent.Future<Image> applyTransformAsync(Transform transform,
                                                               Image image,
                                                               InputSettings inputSettings,
                                                               OutputSettings outputSettings)
        Asynchronously applies the provided transform to the provided image encoding the transformed image stored using settings int