public class ImagingApi extends Object
Modifier and Type | Field and Description |
---|---|
Configuration |
Configuration
The configuration
|
static String |
Version
Current SDK version
|
Constructor and Description |
---|
ImagingApi(String baseUrl)
Initializes a new instance of the ImagingApi class for on-premise deployment service usage.
|
ImagingApi(String appKey,
String appSid)
Initializes a new instance of the ImagingApi class for Aspose Cloud-hosted service usage.
|
ImagingApi(String baseUrl,
String apiVersion,
Boolean debugMode)
Initializes a new instance of the ImagingApi class for on-premise deployment service usage.
|
ImagingApi(String appKey,
String appSid,
String baseUrl)
Initializes a new instance of the ImagingApi class for Aspose Cloud-hosted service usage.
|
ImagingApi(String appKey,
String appSid,
String baseUrl,
String apiVersion)
Initializes a new instance of the ImagingApi class for Aspose Cloud-hosted service usage.
|
ImagingApi(String appKey,
String appSid,
String baseUrl,
String apiVersion,
Boolean debug)
Initializes a new instance of the ImagingApi class for Aspose Cloud-hosted service usage.
|
Modifier and Type | Method and Description |
---|---|
void |
addSearchImage(AddSearchImageRequest request)
Add image and images features to search context.
|
void |
appendTiff(AppendTiffRequest request)
Appends existing TIFF image to another existing TIFF image (i.e.
|
SearchResultsSet |
compareImages(CompareImagesRequest request)
Compare two images.
|
byte[] |
convertImage(ConvertImageRequest request)
Convert existing image to another format.
|
byte[] |
convertTiffToFax(ConvertTiffToFaxRequest request)
Update parameters of existing TIFF image accordingly to fax parameters.
|
void |
copyFile(CopyFileRequest request)
Copy file
|
void |
copyFolder(CopyFolderRequest request)
Copy folder
|
byte[] |
createConvertedImage(CreateConvertedImageRequest request)
Convert existing image to another format.
|
byte[] |
createCroppedImage(CreateCroppedImageRequest request)
Crop an image.
|
byte[] |
createDeskewedImage(CreateDeskewedImageRequest request)
Deskew an image.
|
byte[] |
createFaxTiff(CreateFaxTiffRequest request)
Update parameters of TIFF image accordingly to fax parameters.
|
void |
createFolder(CreateFolderRequest request)
Create the folder
|
byte[] |
createGrayscaledImage(CreateGrayscaledImageRequest request)
Grayscales an image.
|
void |
createImageFeatures(CreateImageFeaturesRequest request)
Extract images features and add them to search context.
|
byte[] |
createImageFrame(CreateImageFrameRequest request)
Get separate frame from existing image.
|
byte[] |
createImageFrameRange(CreateImageFrameRangeRequest request)
Get frames range from existing image.
|
SearchContextStatus |
createImageSearch(CreateImageSearchRequest request)
Create new search context.
|
void |
createImageTag(CreateImageTagRequest request)
Add tag and reference image to search context.
|
byte[] |
createModifiedBmp(CreateModifiedBmpRequest request)
Update parameters of BMP image.
|
byte[] |
createModifiedEmf(CreateModifiedEmfRequest request)
Process existing EMF imaging using given parameters.
|
byte[] |
createModifiedGif(CreateModifiedGifRequest request)
Update parameters of GIF image.
|
byte[] |
createModifiedJpeg(CreateModifiedJpegRequest request)
Update parameters of JPEG image.
|
byte[] |
createModifiedJpeg2000(CreateModifiedJpeg2000Request request)
Update parameters of JPEG2000 image.
|
byte[] |
createModifiedPsd(CreateModifiedPsdRequest request)
Update parameters of PSD image.
|
byte[] |
createModifiedSvg(CreateModifiedSvgRequest request)
Update parameters of SVG image.
|
byte[] |
createModifiedTiff(CreateModifiedTiffRequest request)
Update parameters of TIFF image.
|
byte[] |
createModifiedWebP(CreateModifiedWebPRequest request)
Update parameters of WEBP image.
|
byte[] |
createModifiedWmf(CreateModifiedWmfRequest request)
Process existing WMF image using given parameters.
|
DetectedObjectList |
createObjectBounds(CreateObjectBoundsRequest request)
Detects objects bounds.
|
byte[] |
createResizedImage(CreateResizedImageRequest request)
Resize an image.
|
byte[] |
createRotateFlippedImage(CreateRotateFlippedImageRequest request)
Rotate and/or flip an image.
|
byte[] |
createUpdatedImage(CreateUpdatedImageRequest request)
Perform scaling, cropping and flipping of an image in a single request.
|
byte[] |
createVisualObjectBounds(CreateVisualObjectBoundsRequest request)
Detects objects bounds and draw them on the original image.
|
void |
createWebSiteImageFeatures(CreateWebSiteImageFeaturesRequest request)
Extract images features from web page and add them to search context
|
byte[] |
cropImage(CropImageRequest request)
Crop an existing image.
|
void |
deleteFile(DeleteFileRequest request)
Delete file
|
void |
deleteFolder(DeleteFolderRequest request)
Delete folder
|
void |
deleteImageFeatures(DeleteImageFeaturesRequest request)
Deletes image features from search context.
|
void |
deleteImageSearch(DeleteImageSearchRequest request)
Deletes the search context.
|
void |
deleteSearchImage(DeleteSearchImageRequest request)
Delete image and images features from search context
|
byte[] |
deskewImage(DeskewImageRequest request)
Deskew an existing image.
|
byte[] |
downloadFile(DownloadFileRequest request)
Download file
|
ImageFeatures |
extractImageFeatures(ExtractImageFeaturesRequest request)
Extract features from image without adding to search context.
|
ImagingResponse |
extractImageFrameProperties(ExtractImageFramePropertiesRequest request)
Get separate frame properties of existing image.
|
ImagingResponse |
extractImageProperties(ExtractImagePropertiesRequest request)
Get properties of an image.
|
byte[] |
filterEffectImage(FilterEffectImageRequest request)
Apply filtering effects to an existing image.
|
ImageDuplicatesSet |
findImageDuplicates(FindImageDuplicatesRequest request)
Find images duplicates.
|
SearchResultsSet |
findImagesByTags(FindImagesByTagsRequest request)
Find images by tags.
|
SearchResultsSet |
findSimilarImages(FindSimilarImagesRequest request)
Find similar images.
|
AvailableLabelsList |
getAvailableLabels(GetAvailableLabelsRequest request)
Gets available labels for selected object detection method.
|
DiscUsage |
getDiscUsage(GetDiscUsageRequest request)
Get disc usage
|
FilesList |
getFilesList(GetFilesListRequest request)
Get all files and folders within a folder
|
FileVersions |
getFileVersions(GetFileVersionsRequest request)
Get file versions
|
ImageFeatures |
getImageFeatures(GetImageFeaturesRequest request)
Gets image features from search context.
|
byte[] |
getImageFrame(GetImageFrameRequest request)
Get separate frame from existing image.
|
ImagingResponse |
getImageFrameProperties(GetImageFramePropertiesRequest request)
Get separate frame properties of existing image.
|
byte[] |
getImageFrameRange(GetImageFrameRangeRequest request)
Get frames range from existing image.
|
ImagingResponse |
getImageProperties(GetImagePropertiesRequest request)
Get properties of an image.
|
SearchContextStatus |
getImageSearchStatus(GetImageSearchStatusRequest request)
Gets the search context status.
|
DetectedObjectList |
getObjectBounds(GetObjectBoundsRequest request)
Detects objects' bounds
|
byte[] |
getSearchImage(GetSearchImageRequest request)
Get image from search context
|
byte[] |
getVisualObjectBounds(GetVisualObjectBoundsRequest request)
Detects objects bounds and draw them on the original image
|
byte[] |
grayscaleImage(GrayscaleImageRequest request)
Grayscale an existing image.
|
byte[] |
modifyBmp(ModifyBmpRequest request)
Update parameters of existing BMP image.
|
byte[] |
modifyEmf(ModifyEmfRequest request)
Process existing EMF imaging using given parameters.
|
byte[] |
modifyGif(ModifyGifRequest request)
Update parameters of existing GIF image.
|
byte[] |
modifyJpeg(ModifyJpegRequest request)
Update parameters of existing JPEG image.
|
byte[] |
modifyJpeg2000(ModifyJpeg2000Request request)
Update parameters of existing JPEG2000 image.
|
byte[] |
modifyPsd(ModifyPsdRequest request)
Update parameters of existing PSD image.
|
byte[] |
modifySvg(ModifySvgRequest request)
Update parameters of existing SVG image.
|
byte[] |
modifyTiff(ModifyTiffRequest request)
Update parameters of existing TIFF image.
|
byte[] |
modifyWebP(ModifyWebPRequest request)
Update parameters of existing WEBP image.
|
byte[] |
modifyWmf(ModifyWmfRequest request)
Process existing WMF image using given parameters.
|
void |
moveFile(MoveFileRequest request)
Move file
|
void |
moveFolder(MoveFolderRequest request)
Move folder
|
ObjectExist |
objectExists(ObjectExistsRequest request)
Check if file or folder exists
|
byte[] |
resizeImage(ResizeImageRequest request)
Resize an existing image.
|
byte[] |
rotateFlipImage(RotateFlipImageRequest request)
Rotate and/or flip an existing image.
|
StorageExist |
storageExists(StorageExistsRequest request)
Check if storage exists
|
byte[] |
updateImage(UpdateImageRequest request)
Perform scaling, cropping and flipping of an existing image in a single request.
|
void |
updateImageFeatures(UpdateImageFeaturesRequest request)
Update images features in search context.
|
void |
updateSearchImage(UpdateSearchImageRequest request)
Update image and images features in search context.
|
FilesUploadResult |
uploadFile(UploadFileRequest request)
Upload file
|
public static final String Version
public Configuration Configuration
public ImagingApi(String baseUrl)
baseUrl
- The base URL.public ImagingApi(String appKey, String appSid)
appKey
- The app key.appSid
- The app SID.public ImagingApi(String baseUrl, String apiVersion, Boolean debugMode) throws Exception
baseUrl
- The base URL.apiVersion
- API version.debug
- If debug mode is enabled.Exception
public ImagingApi(String appKey, String appSid, String baseUrl)
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.public ImagingApi(String appKey, String appSid, String baseUrl, String apiVersion) throws Exception
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.apiVersion
- API version.Exception
public ImagingApi(String appKey, String appSid, String baseUrl, String apiVersion, Boolean debug) throws Exception
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.apiVersion
- API version.debug
- If debug mode is enabled.Exception
public void addSearchImage(AddSearchImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void appendTiff(AppendTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet compareImages(CompareImagesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] convertImage(ConvertImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] convertTiffToFax(ConvertTiffToFaxRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void copyFile(CopyFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void copyFolder(CopyFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createConvertedImage(CreateConvertedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createCroppedImage(CreateCroppedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createDeskewedImage(CreateDeskewedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createFaxTiff(CreateFaxTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void createFolder(CreateFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createGrayscaledImage(CreateGrayscaledImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void createImageFeatures(CreateImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createImageFrame(CreateImageFrameRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createImageFrameRange(CreateImageFrameRangeRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchContextStatus createImageSearch(CreateImageSearchRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void createImageTag(CreateImageTagRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedBmp(CreateModifiedBmpRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedEmf(CreateModifiedEmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedGif(CreateModifiedGifRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedJpeg(CreateModifiedJpegRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedJpeg2000(CreateModifiedJpeg2000Request request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedPsd(CreateModifiedPsdRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedSvg(CreateModifiedSvgRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedTiff(CreateModifiedTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedWebP(CreateModifiedWebPRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createModifiedWmf(CreateModifiedWmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public DetectedObjectList createObjectBounds(CreateObjectBoundsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createResizedImage(CreateResizedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createRotateFlippedImage(CreateRotateFlippedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createUpdatedImage(CreateUpdatedImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] createVisualObjectBounds(CreateVisualObjectBoundsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void createWebSiteImageFeatures(CreateWebSiteImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] cropImage(CropImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteFile(DeleteFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteFolder(DeleteFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteImageFeatures(DeleteImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteImageSearch(DeleteImageSearchRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteSearchImage(DeleteSearchImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] deskewImage(DeskewImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] downloadFile(DownloadFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageFeatures extractImageFeatures(ExtractImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse extractImageFrameProperties(ExtractImageFramePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse extractImageProperties(ExtractImagePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] filterEffectImage(FilterEffectImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageDuplicatesSet findImageDuplicates(FindImageDuplicatesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet findImagesByTags(FindImagesByTagsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet findSimilarImages(FindSimilarImagesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public AvailableLabelsList getAvailableLabels(GetAvailableLabelsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public DiscUsage getDiscUsage(GetDiscUsageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FileVersions getFileVersions(GetFileVersionsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FilesList getFilesList(GetFilesListRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageFeatures getImageFeatures(GetImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageFrame(GetImageFrameRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse getImageFrameProperties(GetImageFramePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageFrameRange(GetImageFrameRangeRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse getImageProperties(GetImagePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchContextStatus getImageSearchStatus(GetImageSearchStatusRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public DetectedObjectList getObjectBounds(GetObjectBoundsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getSearchImage(GetSearchImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getVisualObjectBounds(GetVisualObjectBoundsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] grayscaleImage(GrayscaleImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyBmp(ModifyBmpRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyEmf(ModifyEmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyGif(ModifyGifRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyJpeg(ModifyJpegRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyJpeg2000(ModifyJpeg2000Request request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyPsd(ModifyPsdRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifySvg(ModifySvgRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyTiff(ModifyTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyWebP(ModifyWebPRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] modifyWmf(ModifyWmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void moveFile(MoveFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void moveFolder(MoveFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ObjectExist objectExists(ObjectExistsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] resizeImage(ResizeImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] rotateFlipImage(RotateFlipImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public StorageExist storageExists(StorageExistsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] updateImage(UpdateImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void updateImageFeatures(UpdateImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void updateSearchImage(UpdateSearchImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FilesUploadResult uploadFile(UploadFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
Copyright © 2020 Aspose Pty Ltd. All rights reserved.