Filestack Documentation

Class Transform

public class Transform  

:nodoc:

Transform Transform PixelateFacesTransform PixelateFacesTransform PixelateFacesTransform->Transform PDFConvertTransform PDFConvertTransform PDFConvertTransform->Transform ConvertTransform ConvertTransform ConvertTransform->Transform ImageSizeTransform ImageSizeTransform ImageSizeTransform->Transform ModulateTransform ModulateTransform ModulateTransform->Transform OilPaintTransform OilPaintTransform OilPaintTransform->Transform CompressTransform CompressTransform CompressTransform->Transform AutoImageTransform AutoImageTransform AutoImageTransform->Transform ZipTransform ZipTransform ZipTransform->Transform BlackAndWhiteTransform BlackAndWhiteTransform BlackAndWhiteTransform->Transform RoundedCornersTransform RoundedCornersTransform RoundedCornersTransform->Transform ASCIITransform ASCIITransform ASCIITransform->Transform TagsTransform TagsTransform TagsTransform->Transform BorderTransform BorderTransform BorderTransform->Transform FlipTransform FlipTransform FlipTransform->Transform PDFMonochromeTransform PDFMonochromeTransform PDFMonochromeTransform->Transform CropFacesTransform CropFacesTransform CropFacesTransform->Transform TornEdgesTransform TornEdgesTransform TornEdgesTransform->Transform DetectFacesTransform DetectFacesTransform DetectFacesTransform->Transform WatermarkTransform WatermarkTransform WatermarkTransform->Transform EnhanceTransform EnhanceTransform EnhanceTransform->Transform BlurTransform BlurTransform BlurTransform->Transform PartialPixelateTransform PartialPixelateTransform PartialPixelateTransform->Transform NoMetadataTransform NoMetadataTransform NoMetadataTransform->Transform AVTransform AVTransform AVTransform->Transform FlopTransform FlopTransform FlopTransform->Transform AnimateTransform AnimateTransform AnimateTransform->Transform MinifyCSSTransform MinifyCSSTransform MinifyCSSTransform->Transform FallbackTransform FallbackTransform FallbackTransform->Transform CacheTransform CacheTransform CacheTransform->Transform OCRTransform OCRTransform OCRTransform->Transform URLScreenshotTransform URLScreenshotTransform URLScreenshotTransform->Transform MinifyJSTransform MinifyJSTransform MinifyJSTransform->Transform VignetteTransform VignetteTransform VignetteTransform->Transform CropTransform CropTransform CropTransform->Transform RotateTransform RotateTransform RotateTransform->Transform ResizeTransform ResizeTransform ResizeTransform->Transform NegativeTransform NegativeTransform NegativeTransform->Transform ProgressiveJPEGTransform ProgressiveJPEGTransform ProgressiveJPEGTransform->Transform MonochromeTransform MonochromeTransform MonochromeTransform->Transform SharpenTransform SharpenTransform SharpenTransform->Transform PolaroidTransform PolaroidTransform PolaroidTransform->Transform PartialBlurTransform PartialBlurTransform PartialBlurTransform->Transform UpscaleTransform UpscaleTransform UpscaleTransform->Transform DocumentDetectionTransform DocumentDetectionTransform DocumentDetectionTransform->Transform ShadowTransform ShadowTransform ShadowTransform->Transform SepiaTransform SepiaTransform SepiaTransform->Transform PDFInfoTransform PDFInfoTransform PDFInfoTransform->Transform PixelateTransform PixelateTransform PixelateTransform->Transform CircleTransform CircleTransform CircleTransform->Transform RedEyeRemovalTransform RedEyeRemovalTransform RedEyeRemovalTransform->Transform QualityTransform QualityTransform QualityTransform->Transform CollageTransform CollageTransform CollageTransform->Transform SecureForWorkTransform SecureForWorkTransform SecureForWorkTransform->Transform BlurFacesTransform BlurFacesTransform BlurFacesTransform->Transform CopyrightTransform CopyrightTransform CopyrightTransform->Transform

Subclasses

ASCIITransform

Converts the image to black and white.

AVTransform

Converts a video or audio to a different format, resolution, sample rate, etc.

AnimateTransform

Converts a set of images to a GIF file.

AutoImageTransform

Changes encoding of the image based on the user agent and therefore provides better compression and quality characteristics compared to their older JPEG and PNG counterparts.

BlackAndWhiteTransform

Converts the image to black and white.

BlurFacesTransform

Blur selected faces contained inside an image.

BlurTransform

Applies a blurring effect to the image.

BorderTransform

Applies a border effect to the image.

CacheTransform

Takes the file or files that are passed into it and compresses them into a zip file.

CircleTransform

Applies a circle border effect to the image.

CollageTransform

The collage task accepts an array of Filestack file handles, storage aliases, or external URLs. These files are appended in given order to the base file of the transformation URL. Altogther the base image and the passed files are the images that will comprise the collage. The order in which they are added dictates how the images will be arranged.

CompressTransform

Utilizes mozjpeg to offer improved compression for JPGS over the algorithm used for output=compress:true. It will not attempt to re-compress a previously compressed image.

ConvertTransform

Converts the image to a different format.

CopyrightTransform

Detects whether your image is copyright protected or not, and if it is protected, returns all types and related details such as purchase link, etc.

CropFacesTransform

Crops selected faces contained inside an image.

CropTransform

Crops the image to a specified rectangle.

DetectFacesTransform

Detects the faces contained inside an image.

DocumentDetectionTransform

Detects your document in the image, transforms it to fully fit the image, and preprocesses it using de-noising and distortion reduction in order to increase the accuracy of OCR engine in text extraction.

EnhanceTransform

Smartly analyzes a photo and performs color correction and other enhancements to improve the overall quality of the image.

FallbackTransform

Returns default file if the source of the transformation does not work or the transformation fails.

FlipTransform

Flips/mirrors the image vertically.

FlopTransform

Flips/mirrors the image horizontally.

ImageSizeTransform

Returns the width and height of a given image.

MinifyCSSTransform

Minifies your CSS files.

MinifyJSTransform

Minifies your JavaScript files.

ModulateTransform

Changes the image brightness, saturation and hue.

MonochromeTransform

Converts the image to monochrome.

NegativeTransform

Returns a negative image by portraying the lightest area as the darkest and the darkest areas as the lightest.

NoMetadataTransform

Removes any metadata embedded in an image.

OCRTransform

Detects both printed and handwritten texts in images. The result follows the standard JSON format containing all of the details regarding detected text areas, lines, and words.

OilPaintTransform

Change the image to look like it was oil painted.

PDFConvertTransform

Converts a PDF to a specific orientation, page format, and, optionally, extracts specific pages.

PDFInfoTransform

Gets information about a PDF document.

PDFMonochromeTransform

Converts a PDF to black and white version.

PartialBlurTransform

Changes image brightness, saturation and hue.

PartialPixelateTransform

Changes image brightness, saturation and hue.

PixelateFacesTransform

Pixelates selected faces contained inside an image.

PixelateTransform

Pixelates the image.

PolaroidTransform

Applies a Polaroid border effect to the image.

ProgressiveJPEGTransform

Converts an image to progressive JPEG.

QualityTransform

Sets the quality of your JPG or WEBP image without the danger of possibly generating a larger file.

RedEyeRemovalTransform

Removes the red eye effect from photos.

ResizeTransform

Resizes the image to a given width and height using a particular fit and alignment mode.

RotateTransform

Rotates an image in a range from 0 to 359 degrees or based on Exif information.

RoundedCornersTransform

Rounds the image's corners.

SecureForWorkTransform

Returns whether the image if safe to display.

SepiaTransform

Converts the image to sepia color.

ShadowTransform

Applies a shadow border effect to the image.

SharpenTransform

Applies a sharpening effect to the image.

TagsTransform

Analyzes and returns any tags associated to this image.

TornEdgesTransform

Applies a torn edge border effect to the image.

URLScreenshotTransform

Captures content of given URL. The URL screenshot task will not work for content that is located in areas that require you to login. If the content is not publicly visible, then it will not be captured.

UpscaleTransform

Upscales the image making it two times bigger.

VignetteTransform

Applies a vignette border effect to the image.

WatermarkTransform

Watermarks the image by overlaying another image on top of your main image.

ZipTransform

Takes the file or files that are passed into it and compresses them into a zip file.

Nested Type Aliases

Animate

typealias Animate = AnimateTransform

Shortcut for AnimateTransform.

ASCII

typealias ASCII = ASCIITransform

Shortcut for ASCIITransform.

Auto​Image

typealias AutoImage = AutoImageTransform

Shortcut for AutoImageTransform.

AV

typealias AV = AVTransform

Shortcut for AVTransform.

Black​And​White

typealias BlackAndWhite = BlackAndWhiteTransform

Shortcut for BlackAndWhiteTransform.

Blur​Faces

typealias BlurFaces = BlurFacesTransform

Shortcut for BlurFacesTransform.

Blur

typealias Blur = BlurTransform

Shortcut for BlurTransform.

Border

typealias Border = BorderTransform

Shortcut for BorderTransform.

Cache

typealias Cache = CacheTransform

Shortcut for CacheTransform.

Circle

typealias Circle = CircleTransform

Shortcut for CircleTransform.

Collage

typealias Collage = CollageTransform

Shortcut for CollageTransform.

Compress

typealias Compress = CompressTransform

Shortcut for CompressTransform.

Convert

typealias Convert = ConvertTransform

Shortcut for ConvertTransform.

Copyright

typealias Copyright = CopyrightTransform

Shortcut for CopyrightTransform.

Crop​Faces

typealias CropFaces = CropFacesTransform

Shortcut for CropFacesTransform.

Crop

typealias Crop = CropTransform

Shortcut for CropTransform.

Detect​Faces

typealias DetectFaces = DetectFacesTransform

Shortcut for DetectFacesTransform.

Document​Detection

typealias DocumentDetection = DocumentDetectionTransform

Shortcut for DocumentDetectionTransform.

Enhance

typealias Enhance = EnhanceTransform

Shortcut for EnhanceTransform.

Fallback

typealias Fallback = FallbackTransform

Shortcut for FallbackTransform.

Flip

typealias Flip = FlipTransform

Shortcut for FlipTransform.

Flop

typealias Flop = FlopTransform

Shortcut for FlopTransform.

Image​Size

typealias ImageSize = ImageSizeTransform

Shortcut for ImageSizeTransform.

Minify​CSS

typealias MinifyCSS = MinifyCSSTransform

Shortcut for MinifyCSSTransform.

Minify​JS

typealias MinifyJS = MinifyJSTransform

Shortcut for MinifyJSTransform.

Modulate

typealias Modulate = ModulateTransform

Shortcut for ModulateTransform.

Monochrome

typealias Monochrome = MonochromeTransform

Shortcut for MonochromeTransform.

Negative

typealias Negative = NegativeTransform

Shortcut for NegativeTransform.

NoMetadata

typealias NoMetadata = NoMetadataTransform

Shortcut for NoMetadataTransform.

OCR

typealias OCR = OCRTransform

Shortcut for OCRTransform.

Oil​Paint

typealias OilPaint = OilPaintTransform

Shortcut for OilPaintTransform.

Partial​Blur

typealias PartialBlur = PartialBlurTransform

Shortcut for PartialBlurTransform.

Partial​Pixelate

typealias PartialPixelate = PartialPixelateTransform

Shortcut for PartialPixelateTransform.

PDFConvert

typealias PDFConvert = PDFConvertTransform

Shortcut for PDFConvertTransform.

PDFInfo

typealias PDFInfo = PDFInfoTransform

Shortcut for PDFInfoTransform.

PDFMonochrome

typealias PDFMonochrome = PDFMonochromeTransform

Shortcut for PDFMonochromeTransform.

Pixelate​Faces

typealias PixelateFaces = PixelateFacesTransform

Shortcut for PixelateFacesTransform.

Pixelate

typealias Pixelate = PixelateTransform

Shortcut for PixelateTransform.

Polaroid

typealias Polaroid = PolaroidTransform

Shortcut for PolaroidTransform.

Progressive​JPEG

typealias ProgressiveJPEG = ProgressiveJPEGTransform

Shortcut for ProgressiveJPEGTransform.

Quality

typealias Quality = QualityTransform

Shortcut for QualityTransform.

Red​Eye​Removal

typealias RedEyeRemoval = RedEyeRemovalTransform

Shortcut for RedEyeRemovalTransform.

Resize

typealias Resize = ResizeTransform

Shortcut for ResizeTransform.

Rotate

typealias Rotate = RotateTransform

Shortcut for RotateTransform.

Rounded​Corners

typealias RoundedCorners = RoundedCornersTransform

Shortcut for RoundedCornersTransform.

Secure​For​Work

typealias SecureForWork = SecureForWorkTransform

Shortcut for SecureForWorkTransform.

Sepia

typealias Sepia = SepiaTransform

Shortcut for SepiaTransform.

Shadow

typealias Shadow = ShadowTransform

Shortcut for ShadowTransform.

Sharpen

typealias Sharpen = SharpenTransform

Shortcut for SharpenTransform.

Torn​Edges

typealias TornEdges = TornEdgesTransform

Shortcut for TornEdgesTransform.

Upscale

typealias Upscale = UpscaleTransform

Shortcut for UpscaleTransform.

URLScreenshot

typealias URLScreenshot = URLScreenshotTransform

Shortcut for URLScreenshotTransform.

Vignette

typealias Vignette = VignetteTransform

Shortcut for VignetteTransform.

Watermark

typealias Watermark = WatermarkTransform

Shortcut for WatermarkTransform.

Zip

typealias Zip = ZipTransform

Shortcut for ZipTransform.