public class ImagingApi extends Object
Constructor and Description |
---|
ImagingApi(String apiKey,
String appSid) |
ImagingApi(String apiKey,
String appSid,
boolean isDebug) |
ImagingApi(String basePath,
String apiKey,
String appSid) |
ImagingApi(String basePath,
String apiKey,
String appSid,
boolean isDebug) |
Modifier and Type | Method and Description |
---|---|
String |
getBasePath() |
ResponseMessage |
GetChangeImageScale(String name,
String format,
Integer newWidth,
Integer newHeight,
String outPath,
String folder,
String storage)
GetChangeImageScale
Change scale of an existing image
|
ResponseMessage |
GetCropImage(String name,
String format,
Integer x,
Integer y,
Integer width,
Integer height,
String outPath,
String folder,
String storage)
GetCropImage
Crop existing image
|
ResponseMessage |
GetImageBmp(String name,
Integer bitsPerPixel,
Integer horizontalResolution,
Integer verticalResolution,
Boolean fromScratch,
String outPath,
String folder,
String storage)
GetImageBmp
Update parameters of bmp image.
|
ResponseMessage |
GetImageFrame(String name,
Integer frameId,
Integer newWidth,
Integer newHeight,
Integer x,
Integer y,
Integer rectWidth,
Integer rectHeight,
String rotateFlipMethod,
Boolean saveOtherFrames,
String outPath,
String folder,
String storage)
GetImageFrame
Get separate frame of tiff image
|
ImagingResponse |
GetImageFrameProperties(String name,
Integer frameId,
String folder,
String storage)
GetImageFrameProperties
Get properties of a tiff frame.
|
ResponseMessage |
GetImageGif(String name,
Integer backgroundColorIndex,
Integer colorResolution,
Boolean hasTrailer,
Boolean interlaced,
Boolean isPaletteSorted,
Integer pixelAspectRatio,
Boolean fromScratch,
String outPath,
String folder,
String storage)
GetImageGif
Update parameters of bmp image.
|
ResponseMessage |
GetImageJpg(String name,
Integer quality,
String compressionType,
Boolean fromScratch,
String outPath,
String folder,
String storage)
GetImageJpg
Update parameters of jpg image.
|
ResponseMessage |
GetImagePng(String name,
Boolean fromScratch,
String outPath,
String folder,
String storage)
GetImagePng
Update parameters of png image.
|
ImagingResponse |
GetImageProperties(String name,
String folder,
String storage)
GetImageProperties
Get properties of an image.
|
ResponseMessage |
GetImagePsd(String name,
Integer channelsCount,
String compressionMethod,
Boolean fromScratch,
String outPath,
String folder,
String storage)
GetImagePsd
Update parameters of psd image.
|
ResponseMessage |
GetImageRotateFlip(String name,
String format,
String method,
String outPath,
String folder,
String storage)
GetImageRotateFlip
Rotate and flip existing image
|
ResponseMessage |
GetImageSaveAs(String name,
String format,
String outPath,
String folder,
String storage)
GetImageSaveAs
Export existing image to another format
|
ApiInvoker |
getInvoker() |
ResponseMessage |
GetTiffToFax(String name,
String storage,
String folder,
String outPath)
GetTiffToFax
Get tiff image for fax.
|
ResponseMessage |
GetUpdatedImage(String name,
String format,
Integer newWidth,
Integer newHeight,
Integer x,
Integer y,
Integer rectWidth,
Integer rectHeight,
String rotateFlipMethod,
String outPath,
String folder,
String storage)
GetUpdatedImage
Perform scaling, cropping and flipping of an image in single request.
|
ResponseMessage |
PostChangeImageScale(String format,
Integer newWidth,
Integer newHeight,
String outPath,
File file)
PostChangeImageScale
Change scale of an image from body
|
ResponseMessage |
PostCropImage(String format,
Integer x,
Integer y,
Integer width,
Integer height,
String outPath,
File file)
PostCropImage
Crop image from body
|
ResponseMessage |
PostImageBmp(Integer bitsPerPixel,
Integer horizontalResolution,
Integer verticalResolution,
Boolean fromScratch,
String outPath,
File file)
PostImageBmp
Update parameters of bmp image.
|
ResponseMessage |
PostImageGif(Integer backgroundColorIndex,
Integer colorResolution,
Boolean hasTrailer,
Boolean interlaced,
Boolean isPaletteSorted,
Integer pixelAspectRatio,
Boolean fromScratch,
String outPath,
File file)
PostImageGif
Update parameters of gif image.
|
ResponseMessage |
PostImageJpg(Integer quality,
String compressionType,
Boolean fromScratch,
String outPath,
File file)
PostImageJpg
Update parameters of jpg image.
|
ResponseMessage |
PostImagePng(Boolean fromScratch,
String outPath,
File file)
PostImagePng
Update parameters of png image.
|
ResponseMessage |
PostImagePsd(Integer channelsCount,
String compressionMethod,
Boolean fromScratch,
String outPath,
File file)
PostImagePsd
Update parameters of psd image.
|
ResponseMessage |
PostImageRotateFlip(String format,
String method,
String outPath,
File file)
PostImageRotateFlip
Rotate and flip existing image and get it from response.
|
ResponseMessage |
PostImageSaveAs(String format,
Integer newWidth,
Integer newHeight,
Integer x,
Integer y,
Integer rectWidth,
Integer rectHeight,
String rotateFlipMethod,
String outPath,
File file)
PostImageSaveAs
Perform scaling, cropping and flipping of an image in single request.
|
ResponseMessage |
PostImageSaveAs(String format,
String outPath,
File file)
PostImageSaveAs
Export existing image to another format.
|
ResponseMessage |
PostProcessTiff(String compression,
String resolutionUnit,
Integer bitDepth,
Boolean fromScratch,
Float horizontalResolution,
Float verticalResolution,
String outPath,
File file)
PostProcessTiff
Update tiff image.
|
SaaSposeResponse |
PostTiffAppend(String name,
String appendFile,
String storage,
String folder)
PostTiffAppend
Append tiff image.
|
void |
setBasePath(String basePath) |
public ApiInvoker getInvoker()
public void setBasePath(String basePath)
public String getBasePath()
public ResponseMessage GetImageBmp(String name, Integer bitsPerPixel, Integer horizontalResolution, Integer verticalResolution, Boolean fromScratch, String outPath, String folder, String storage)
name
- String Filename of image.bitsPerPixel
- Integer Color depth.horizontalResolution
- Integer New horizontal resolution.verticalResolution
- Integer New vertical resolution.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageBmp(Integer bitsPerPixel, Integer horizontalResolution, Integer verticalResolution, Boolean fromScratch, String outPath, File file)
bitsPerPixel
- Integer Color depth.horizontalResolution
- Integer New horizontal resolution.verticalResolution
- Integer New vertical resolution.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetCropImage(String name, String format, Integer x, Integer y, Integer width, Integer height, String outPath, String folder, String storage)
name
- String The image name.format
- String Output file format. Valid Formats: Bmp, png, jpg, tiff, psd, gif.x
- Integer X position of start point for cropping rectangley
- Integer Y position of start point for cropping rectanglewidth
- Integer Width of cropping rectangleheight
- Integer Height of cropping rectangleoutPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostCropImage(String format, Integer x, Integer y, Integer width, Integer height, String outPath, File file)
format
- String Output file format. Valid Formats: Bmp, png, jpg, tiff, psd, gif.x
- Integer X position of start point for cropping rectangley
- Integer Y position of start point for cropping rectanglewidth
- Integer Width of cropping rectangleheight
- Integer Height of cropping rectangleoutPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetImageFrame(String name, Integer frameId, Integer newWidth, Integer newHeight, Integer x, Integer y, Integer rectWidth, Integer rectHeight, String rotateFlipMethod, Boolean saveOtherFrames, String outPath, String folder, String storage)
name
- String Filename of image.frameId
- Integer Number of frame.newWidth
- Integer New width of the scaled image.newHeight
- Integer New height of the scaled image.x
- Integer X position of start point for cropping rectangley
- Integer Y position of start point for cropping rectanglerectWidth
- Integer Width of cropping rectanglerectHeight
- Integer Height of cropping rectanglerotateFlipMethod
- String RotateFlip method.(Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY. Default is RotateNoneFlipNone.)saveOtherFrames
- Boolean Include all other frames or just specified frame in response.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ImagingResponse GetImageFrameProperties(String name, Integer frameId, String folder, String storage)
name
- String Filename with image.frameId
- Integer Number of frame.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage GetImageGif(String name, Integer backgroundColorIndex, Integer colorResolution, Boolean hasTrailer, Boolean interlaced, Boolean isPaletteSorted, Integer pixelAspectRatio, Boolean fromScratch, String outPath, String folder, String storage)
name
- String Filename of image.backgroundColorIndex
- Integer Index of the background color.colorResolution
- Integer Color resolution.hasTrailer
- Boolean Specifies if image has trailer.interlaced
- Boolean Specifies if image is interlaced.isPaletteSorted
- Boolean Specifies if palette is sorted.pixelAspectRatio
- Integer Pixel aspect ratio.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageGif(Integer backgroundColorIndex, Integer colorResolution, Boolean hasTrailer, Boolean interlaced, Boolean isPaletteSorted, Integer pixelAspectRatio, Boolean fromScratch, String outPath, File file)
backgroundColorIndex
- Integer Index of the background color.colorResolution
- Integer Color resolution.hasTrailer
- Boolean Specifies if image has trailer.interlaced
- Boolean Specifies if image is interlaced.isPaletteSorted
- Boolean Specifies if palette is sorted.pixelAspectRatio
- Integer Pixel aspect ratio.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetImageJpg(String name, Integer quality, String compressionType, Boolean fromScratch, String outPath, String folder, String storage)
name
- String Filename of image.quality
- Integer Quality of image. From 0 to 100. Default is 75compressionType
- String Compression type.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageJpg(Integer quality, String compressionType, Boolean fromScratch, String outPath, File file)
quality
- Integer Quality of image. From 0 to 100. Default is 75compressionType
- String Compression type.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetImagePng(String name, Boolean fromScratch, String outPath, String folder, String storage)
name
- String Filename of image.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImagePng(Boolean fromScratch, String outPath, File file)
fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ImagingResponse GetImageProperties(String name, String folder, String storage)
name
- String The image name.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage GetImagePsd(String name, Integer channelsCount, String compressionMethod, Boolean fromScratch, String outPath, String folder, String storage)
name
- String Filename of image.channelsCount
- Integer Count of channels.compressionMethod
- String Compression method.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImagePsd(Integer channelsCount, String compressionMethod, Boolean fromScratch, String outPath, File file)
channelsCount
- Integer Count of channels.compressionMethod
- String Compression method.fromScratch
- Boolean Specifies where additional parameters we do not support should be taken from. If this is true � they will be taken from default values for standard image, if it is false � they will be saved from current image. Default is false.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetChangeImageScale(String name, String format, Integer newWidth, Integer newHeight, String outPath, String folder, String storage)
name
- String The image name.format
- String Output file format. Valid Formats: Bmp, png, jpg, tiff, psd, gif.newWidth
- Integer New width of the scaled image.newHeight
- Integer New height of the scaled image.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostChangeImageScale(String format, Integer newWidth, Integer newHeight, String outPath, File file)
format
- String Output file format. Valid Formats: Bmp, png, jpg, tiff, psd, gif.newWidth
- Integer New width of the scaled image.newHeight
- Integer New height of the scaled image.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetImageRotateFlip(String name, String format, String method, String outPath, String folder, String storage)
name
- String Filename of image.format
- String Number of frame. (Bmp, png, jpg, tiff, psd, gif.)method
- String New width of the scaled image. (Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY)outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageRotateFlip(String format, String method, String outPath, File file)
format
- String Number of frame. (Bmp, png, jpg, tiff, psd, gif.)method
- String New width of the scaled image. (Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY)outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetImageSaveAs(String name, String format, String outPath, String folder, String storage)
name
- String Filename of image.format
- String Output file format. (Bmp, png, jpg, tiff, psd, gif.)outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageSaveAs(String format, String outPath, File file)
format
- String Output file format. (Bmp, png, jpg, tiff, psd, gif.)outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- Filepublic ResponseMessage GetTiffToFax(String name, String storage, String folder, String outPath)
name
- String The image file name.storage
- String The image file storage.folder
- String The image file folder.outPath
- String Path to save resultpublic ResponseMessage PostProcessTiff(String compression, String resolutionUnit, Integer bitDepth, Boolean fromScratch, Float horizontalResolution, Float verticalResolution, String outPath, File file)
compression
- String New compression.resolutionUnit
- String New resolution unit.bitDepth
- Integer New bit depth.fromScratch
- BooleanhorizontalResolution
- Float New horizontal resolution.verticalResolution
- Float New verstical resolution.outPath
- String Path to save resultfile
- Filepublic SaaSposeResponse PostTiffAppend(String name, String appendFile, String storage, String folder)
name
- String Original image name.appendFile
- String Second image file name.storage
- String The images storage.folder
- String The images folder.public ResponseMessage GetUpdatedImage(String name, String format, Integer newWidth, Integer newHeight, Integer x, Integer y, Integer rectWidth, Integer rectHeight, String rotateFlipMethod, String outPath, String folder, String storage)
name
- String Filename of image.format
- String Save image in another format. By default format remains the samenewWidth
- Integer New Width of the scaled image.newHeight
- Integer New height of the scaled image.x
- Integer X position of start point for cropping rectangley
- Integer Y position of start point for cropping rectanglerectWidth
- Integer Width of cropping rectanglerectHeight
- Integer Height of cropping rectanglerotateFlipMethod
- String RotateFlip method. Default is RotateNoneFlipNone.outPath
- String Path to updated file, if this is empty, response contains streamed image.folder
- String Folder with image to process.storage
- Stringpublic ResponseMessage PostImageSaveAs(String format, Integer newWidth, Integer newHeight, Integer x, Integer y, Integer rectWidth, Integer rectHeight, String rotateFlipMethod, String outPath, File file)
format
- String Save image in another format. By default format remains the samenewWidth
- Integer New Width of the scaled image.newHeight
- Integer New height of the scaled image.x
- Integer X position of start point for cropping rectangley
- Integer Y position of start point for cropping rectanglerectWidth
- Integer Width of cropping rectanglerectHeight
- Integer Height of cropping rectanglerotateFlipMethod
- String RotateFlip method. Default is RotateNoneFlipNone.outPath
- String Path to updated file, if this is empty, response contains streamed image.file
- FileCopyright © 2016. All rights reserved.