com.pdfcrowd

Class Pdfcrowd.ImageToImageClient

java.lang.Object

com.pdfcrowd.Pdfcrowd.ImageToImageClient

Enclosing class:

Pdfcrowd

public static final class Pdfcrowd.ImageToImageClient
extends Object

Conversion from one image format to another image format.

Constructor Summary

Constructors

Constructor and Description
ImageToImageClient(String userName, String apiKey) Constructor for the PDFCrowd API client.

Method Summary

Modifier and Type	Method and Description
byte[]	convertFile(String file) Convert a local file.
void	convertFileToFile(String file, String filePath) Convert a local file and write the result to a local file.
void	convertFileToStream(String file, OutputStream outStream) Convert a local file and write the result to an output stream.
byte[]	convertRawData(byte[] data) Convert raw data.
void	convertRawDataToFile(byte[] data, String filePath) Convert raw data to a file.
void	convertRawDataToStream(byte[] data, OutputStream outStream) Convert raw data and write the result to an output stream.
byte[]	convertStream(InputStream inStream) Convert the contents of an input stream.
void	convertStreamToFile(InputStream inStream, String filePath) Convert the contents of an input stream and write the result to a local file.
void	convertStreamToStream(InputStream inStream, OutputStream outStream) Convert the contents of an input stream and write the result to an output stream.
byte[]	convertUrl(String url) Convert an image.
void	convertUrlToFile(String url, String filePath) Convert an image and write the result to a local file.
void	convertUrlToStream(String url, OutputStream outStream) Convert an image and write the result to an output stream.
int	getConsumedCreditCount() Get the number of credits consumed by the last conversion.
String	getDebugLogUrl() Get the URL of the debug log for the last conversion.
String	getJobId() Get the job id.
int	getOutputSize() Get the size of the output in bytes.
int	getRemainingCreditCount() Get the number of conversion credits available in your account.
String	getVersion() Get the version details.
Pdfcrowd.ImageToImageClient	setCanvasBackgroundColor(String color) The canvas background color in RGB or RGBA hexadecimal format.
Pdfcrowd.ImageToImageClient	setCanvasDimensions(String width, String height) Set the output canvas dimensions.
Pdfcrowd.ImageToImageClient	setCanvasHeight(String height) Set the output canvas height.
Pdfcrowd.ImageToImageClient	setCanvasSize(String size) Set the output canvas size.
Pdfcrowd.ImageToImageClient	setCanvasWidth(String width) Set the output canvas width.
Pdfcrowd.ImageToImageClient	setClientUserAgent(String agent) Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
Pdfcrowd.ImageToImageClient	setConverterVersion(String version) Set the converter version.
Pdfcrowd.ImageToImageClient	setCropArea(String x, String y, String width, String height) Set the content area position and size.
Pdfcrowd.ImageToImageClient	setCropAreaHeight(String height) Set the height of the content area.
Pdfcrowd.ImageToImageClient	setCropAreaWidth(String width) Set the width of the content area.
Pdfcrowd.ImageToImageClient	setCropAreaX(String x) Set the top left X coordinate of the content area.
Pdfcrowd.ImageToImageClient	setCropAreaY(String y) Set the top left Y coordinate of the content area.
Pdfcrowd.ImageToImageClient	setDebugLog(boolean value) Turn on the debug logging.
Pdfcrowd.ImageToImageClient	setDpi(int dpi) Set the DPI resolution of the input image.
Pdfcrowd.ImageToImageClient	setHttpProxy(String proxy) A proxy server used by the conversion process for accessing the source URLs with HTTP scheme.
Pdfcrowd.ImageToImageClient	setHttpsProxy(String proxy) A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme.
Pdfcrowd.ImageToImageClient	setMarginBottom(String bottom) Set the output canvas bottom margin.
Pdfcrowd.ImageToImageClient	setMarginLeft(String left) Set the output canvas left margin.
Pdfcrowd.ImageToImageClient	setMarginRight(String right) Set the output canvas right margin.
Pdfcrowd.ImageToImageClient	setMargins(String top, String right, String bottom, String left) Set the output canvas margins.
Pdfcrowd.ImageToImageClient	setMarginTop(String top) Set the output canvas top margin.
Pdfcrowd.ImageToImageClient	setOrientation(String orientation) Set the output canvas orientation.
Pdfcrowd.ImageToImageClient	setOutputFormat(String outputFormat) The format of the output file.
Pdfcrowd.ImageToImageClient	setPosition(String position) Set the image position on the canvas.
Pdfcrowd.ImageToImageClient	setPrintCanvasMode(String mode) Set the mode to print the image on the canvas.
Pdfcrowd.ImageToImageClient	setProxy(String host, int port, String userName, String password) Specifies an HTTP proxy that the API client library will use to connect to the internet.
Pdfcrowd.ImageToImageClient	setRemoveBorders(boolean value) Remove borders of an image which does not change in color.
Pdfcrowd.ImageToImageClient	setResize(String resize) Resize the image.
Pdfcrowd.ImageToImageClient	setRetryCount(int count) Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
Pdfcrowd.ImageToImageClient	setRotate(String rotate) Rotate the image.
Pdfcrowd.ImageToImageClient	setTag(String tag) Tag the conversion with a custom value.
Pdfcrowd.ImageToImageClient	setUseHttp(boolean value) Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
Pdfcrowd.ImageToImageClient	setUserAgent(String agent) Set a custom user agent HTTP header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageToImageClient

public ImageToImageClient(String userName,
                          String apiKey)

Constructor for the PDFCrowd API client.

Parameters:

userName - Your username at PDFCrowd.

apiKey - Your API key.

Method Detail

convertUrl

public byte[] convertUrl(String url)

Convert an image.

Parameters:

url - The address of the image to convert. Supported protocols are http:// and https://.

Returns:

Byte array containing the conversion output.

convertUrlToStream

public void convertUrlToStream(String url,
                               OutputStream outStream)

Convert an image and write the result to an output stream.

Parameters:

url - The address of the image to convert. Supported protocols are http:// and https://.

outStream - The output stream that will contain the conversion output.

convertUrlToFile

public void convertUrlToFile(String url,
                             String filePath)
                      throws IOException

Convert an image and write the result to a local file.

Parameters:

url - The address of the image to convert. Supported protocols are http:// and https://.

filePath - The output file path. The string must not be empty.

Throws:

IOException

convertFile

public byte[] convertFile(String file)

Convert a local file.

Parameters:

file - The path to a local file to convert.
The file must exist and not be empty.

Returns:

Byte array containing the conversion output.

convertFileToStream

public void convertFileToStream(String file,
                                OutputStream outStream)

Convert a local file and write the result to an output stream.

Parameters:

file - The path to a local file to convert.
The file must exist and not be empty.

outStream - The output stream that will contain the conversion output.

convertFileToFile

public void convertFileToFile(String file,
                              String filePath)
                       throws IOException

Convert a local file and write the result to a local file.

Parameters:

file - The path to a local file to convert.
The file must exist and not be empty.

filePath - The output file path. The string must not be empty.

Throws:

IOException

convertRawData

public byte[] convertRawData(byte[] data)

Convert raw data.

Parameters:

data - The raw content to be converted.

Returns:

Byte array with the output.

convertRawDataToStream

public void convertRawDataToStream(byte[] data,
                                   OutputStream outStream)

Convert raw data and write the result to an output stream.

Parameters:

data - The raw content to be converted.

outStream - The output stream that will contain the conversion output.

convertRawDataToFile

public void convertRawDataToFile(byte[] data,
                                 String filePath)
                          throws IOException

Convert raw data to a file.

Parameters:

data - The raw content to be converted.

filePath - The output file path. The string must not be empty.

Throws:

IOException

convertStream

public byte[] convertStream(InputStream inStream)
                     throws IOException

Convert the contents of an input stream.

Parameters:

inStream - The input stream with source data.

Returns:

Byte array containing the conversion output.

Throws:

IOException

convertStreamToStream

public void convertStreamToStream(InputStream inStream,
                                  OutputStream outStream)
                           throws IOException

Convert the contents of an input stream and write the result to an output stream.

Parameters:

inStream - The input stream with source data.

outStream - The output stream that will contain the conversion output.

Throws:

IOException

convertStreamToFile

public void convertStreamToFile(InputStream inStream,
                                String filePath)
                         throws IOException

Convert the contents of an input stream and write the result to a local file.

Parameters:

inStream - The input stream with source data.

filePath - The output file path. The string must not be empty.

Throws:

IOException

setOutputFormat

public Pdfcrowd.ImageToImageClient setOutputFormat(String outputFormat)

The format of the output file.

Parameters:

outputFormat - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.

Returns:

The converter object.

setResize

public Pdfcrowd.ImageToImageClient setResize(String resize)

Resize the image.

Parameters:

resize - The resize percentage or new image dimensions.

Returns:

The converter object.

setRotate

public Pdfcrowd.ImageToImageClient setRotate(String rotate)

Rotate the image.

Parameters:

rotate - The rotation specified in degrees.

Returns:

The converter object.

setCropAreaX

public Pdfcrowd.ImageToImageClient setCropAreaX(String x)

Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.

Parameters:

x - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCropAreaY

public Pdfcrowd.ImageToImageClient setCropAreaY(String y)

Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.

Parameters:

y - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCropAreaWidth

public Pdfcrowd.ImageToImageClient setCropAreaWidth(String width)

Set the width of the content area. It should be at least 1 inch.

Parameters:

width - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCropAreaHeight

public Pdfcrowd.ImageToImageClient setCropAreaHeight(String height)

Set the height of the content area. It should be at least 1 inch.

Parameters:

height - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCropArea

public Pdfcrowd.ImageToImageClient setCropArea(String x,
                                               String y,
                                               String width,
                                               String height)

Set the content area position and size. The content area enables to specify the part to be converted.

Parameters:

x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setRemoveBorders

public Pdfcrowd.ImageToImageClient setRemoveBorders(boolean value)

Remove borders of an image which does not change in color.

Parameters:

value - Set to true to remove borders.

Returns:

The converter object.

setCanvasSize

public Pdfcrowd.ImageToImageClient setCanvasSize(String size)

Set the output canvas size.

Parameters:

size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.

Returns:

The converter object.

setCanvasWidth

public Pdfcrowd.ImageToImageClient setCanvasWidth(String width)

Set the output canvas width.

Parameters:

width - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCanvasHeight

public Pdfcrowd.ImageToImageClient setCanvasHeight(String height)

Set the output canvas height.

Parameters:

height - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCanvasDimensions

public Pdfcrowd.ImageToImageClient setCanvasDimensions(String width,
                                                       String height)

Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.

Parameters:

width - Set the output canvas width. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

height - Set the output canvas height. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setOrientation

public Pdfcrowd.ImageToImageClient setOrientation(String orientation)

Set the output canvas orientation.

Parameters:

orientation - Allowed values are landscape, portrait.

Returns:

The converter object.

setPosition

public Pdfcrowd.ImageToImageClient setPosition(String position)

Set the image position on the canvas.

Parameters:

position - Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.

Returns:

The converter object.

setPrintCanvasMode

public Pdfcrowd.ImageToImageClient setPrintCanvasMode(String mode)

Set the mode to print the image on the canvas.

Parameters:

mode - Allowed values are default, fit, stretch.

Returns:

The converter object.

setMarginTop

public Pdfcrowd.ImageToImageClient setMarginTop(String top)

Set the output canvas top margin.

Parameters:

top - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setMarginRight

public Pdfcrowd.ImageToImageClient setMarginRight(String right)

Set the output canvas right margin.

Parameters:

right - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setMarginBottom

public Pdfcrowd.ImageToImageClient setMarginBottom(String bottom)

Set the output canvas bottom margin.

Parameters:

bottom - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setMarginLeft

public Pdfcrowd.ImageToImageClient setMarginLeft(String left)

Set the output canvas left margin.

Parameters:

left - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setMargins

public Pdfcrowd.ImageToImageClient setMargins(String top,
                                              String right,
                                              String bottom,
                                              String left)

Set the output canvas margins.

Parameters:

top - Set the output canvas top margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

right - Set the output canvas right margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

bottom - Set the output canvas bottom margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

left - Set the output canvas left margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

Returns:

The converter object.

setCanvasBackgroundColor

public Pdfcrowd.ImageToImageClient setCanvasBackgroundColor(String color)

The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.

Parameters:

color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.

Returns:

The converter object.

setDpi

public Pdfcrowd.ImageToImageClient setDpi(int dpi)

Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).

Parameters:

dpi - The DPI value.

Returns:

The converter object.

setDebugLog

public Pdfcrowd.ImageToImageClient setDebugLog(boolean value)

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Parameters:

value - Set to true to enable the debug logging.

Returns:

The converter object.

getDebugLogUrl

public String getDebugLogUrl()

Get the URL of the debug log for the last conversion.

Returns:

The link to the debug log.

getRemainingCreditCount

public int getRemainingCreditCount()

Get the number of conversion credits available in your account. This method can only be called after a call to one of the convertXtoY methods. The returned value can differ from the actual count if you run parallel conversions. The special value 999999 is returned if the information is not available.

Returns:

The number of credits.

getConsumedCreditCount

public int getConsumedCreditCount()

Get the number of credits consumed by the last conversion.

Returns:

The number of credits.

getJobId

public String getJobId()

Get the job id.

Returns:

The unique job identifier.

getOutputSize

public int getOutputSize()

Get the size of the output in bytes.

Returns:

The count of bytes.

getVersion

public String getVersion()

Get the version details.

Returns:

API version, converter version, and client version.

setTag

public Pdfcrowd.ImageToImageClient setTag(String tag)

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

Parameters:

tag - A string with the custom tag.

Returns:

The converter object.

setHttpProxy

public Pdfcrowd.ImageToImageClient setHttpProxy(String proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameters:

proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

Returns:

The converter object.

setHttpsProxy

public Pdfcrowd.ImageToImageClient setHttpsProxy(String proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameters:

proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

Returns:

The converter object.

setConverterVersion

public Pdfcrowd.ImageToImageClient setConverterVersion(String version)

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Parameters:

version - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.

Returns:

The converter object.

setUseHttp

public Pdfcrowd.ImageToImageClient setUseHttp(boolean value)

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

Parameters:

value - Set to true to use HTTP.

Returns:

The converter object.

setClientUserAgent

public Pdfcrowd.ImageToImageClient setClientUserAgent(String agent)

Specifies the User-Agent HTTP header that the client library will use when interacting with the API.

Parameters:

agent - The user agent string.

Returns:

The converter object.

setUserAgent

public Pdfcrowd.ImageToImageClient setUserAgent(String agent)

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Parameters:

agent - The user agent string.

Returns:

The converter object.

setProxy

public Pdfcrowd.ImageToImageClient setProxy(String host,
                                            int port,
                                            String userName,
                                            String password)

Specifies an HTTP proxy that the API client library will use to connect to the internet.

Parameters:

host - The proxy hostname.

port - The proxy port.

userName - The username.

password - The password.

Returns:

The converter object.

setRetryCount

public Pdfcrowd.ImageToImageClient setRetryCount(int count)

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

Parameters:

count - Number of retries.

Returns:

The converter object.