Image to Image / Python Reference

class ImageToImageClient

All setter methods return ImageToImageClient object unless specified otherwise.

Constructor

def __init__(self, user_name, api_key)

Constructor for the PDFCrowd API client.

Parameters:
  • user_name - Your username at PDFCrowd.
  • api_key - Your API key.

Conversion Input

def convertUrl(self, url) { return byte[]; }

Convert an image.

Parameter:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
Returns:
byte[] - Byte array containing the conversion output.

def convertUrlToStream(self, url, out_stream)

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

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • out_stream (OutputStream) - The output stream that will contain the conversion output.

def convertUrlToFile(self, url, file_path)

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

Parameters:
  • url - The address of the image to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • file_path - The output file path.

def convertFile(self, file) { return byte[]; }

Convert a local file.

Parameter:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
Returns:
byte[] - Byte array containing the conversion output.

def convertFileToStream(self, file, out_stream)

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

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • out_stream (OutputStream) - The output stream that will contain the conversion output.

def convertFileToFile(self, file, file_path)

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

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • file_path - The output file path.

def convertRawData(self, data) { return byte[]; }

Convert raw data.

Parameter:
  • data (byte[]) - The raw content to be converted.
Returns:
byte[] - Byte array with the output.

def convertRawDataToStream(self, data, out_stream)

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

Parameters:
  • data (byte[]) - The raw content to be converted.
  • out_stream (OutputStream) - The output stream that will contain the conversion output.

def convertRawDataToFile(self, data, file_path)

Convert raw data to a file.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • file_path - The output file path.

def convertStream(self, in_stream) { return byte[]; }

Convert the contents of an input stream.

Parameter:
  • in_stream (InputStream) - The input stream with source data.
Returns:
byte[] - Byte array containing the conversion output.

def convertStreamToStream(self, in_stream, out_stream)

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

Parameters:
  • in_stream (InputStream) - The input stream with source data.
  • out_stream (OutputStream) - The output stream that will contain the conversion output.

def convertStreamToFile(self, in_stream, file_path)

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

Parameters:
  • in_stream (InputStream) - The input stream with source data.
  • file_path - The output file path.

Conversion Format

def setOutputFormat(self, output_format)

The format of the output file.

Parameter:
  • output_format
    Allowed Values:
    • png
    • jpg
    • gif
    • tiff
    • bmp
    • ico
    • ppm
    • pgm
    • pbm
    • pnm
    • psb
    • pct
    • ras
    • tga
    • sgi
    • sun
    • webp
    Default:
    png

Image Operations

Settings used for operations with images.

def setResize(self, resize)

Resize the image.

Parameter:
  • resize - The resize percentage or new image dimensions.
    Default:
    100%
Examples:
  • Enlarge for high-res display: setResize("200%")
  • Standard XGA screen resolution: setResize("1024x768")

def setRotate(self, rotate)

Rotate the image.

Parameter:
  • rotate - The rotation specified in degrees.

def setCropAreaX(self, x)

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

Parameter:
  • x
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond left edge: setCropAreaX("-1in")
  • Skip narrow border area: setCropAreaX("10mm")

def setCropAreaY(self, y)

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

Parameter:
  • y
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
Examples:
  • Crop extends beyond left edge: setCropAreaY("-1in")
  • Skip narrow border area: setCropAreaY("10mm")

def setCropAreaWidth(self, width)

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

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
Examples:
  • Standard document crop width: setCropAreaWidth("8in")
  • Full A4 page width crop: setCropAreaWidth("210mm")

def setCropAreaHeight(self, height)

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

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.
Examples:
  • Standard document crop width: setCropAreaHeight("8in")
  • Full A4 page width crop: setCropAreaHeight("210mm")

def setCropArea(self, x, y, width, 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.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    0px
  • width - Set the width of the content area. It should be at least 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The width of the print area.
  • height - Set the height of the content area. It should be at least 1 inch.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    Default:
    The height of the print area.

def setRemoveBorders(self, value)

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

Parameter:
  • value (bool) - Set to True to remove borders.
    Default:
    False

Canvas Setup

def setCanvasSize(self, size)

Set the output canvas size.

Parameter:
  • size
    Allowed Values:
    • A0
    • A1
    • A2
    • A3
    • A4
    • A5
    • A6
    • Letter

def setCanvasWidth(self, width)

Set the output canvas width.

Parameter:
  • width
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 landscape / banner width: setCanvasWidth("297mm")
  • US Letter standard width: setCanvasWidth("8.5in")

def setCanvasHeight(self, height)

Set the output canvas height.

Parameter:
  • height
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Large poster canvas height: setCanvasHeight("420mm")
  • US Letter standard height: setCanvasHeight("11in")

def setCanvasDimensions(self, width, 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.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • height - Set the output canvas height.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • A4 portrait dimensions: setCanvasDimensions("210mm", "297mm")
  • US Letter dimensions: setCanvasDimensions("8.5in", "11in")
  • A3 portrait dimensions: setCanvasDimensions("297mm", "420mm")

def setOrientation(self, orientation)

Set the output canvas orientation.

Parameter:
  • orientation
    Allowed Values:
    • landscape
    • portrait
    Default:
    portrait

def setPosition(self, position)

Set the image position on the canvas.

Parameter:
  • position
    Allowed Values:
    • center
    • top
    • bottom
    • left
    • right
    • top-left
    • top-right
    • bottom-left
    • bottom-right
    Default:
    center

def setPrintCanvasMode(self, mode)

Set the mode to print the image on the canvas.

Parameter:
  • mode
    Allowed Values:
    • default — No image scaling.
    • fit — Fit the image to the canvas with aspect ratio.
    • stretch — Stretch the image to the canvas with no aspect ratio.
    Default:
    default

def setMarginTop(self, top)

Set the output canvas top margin.

Parameter:
  • top
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginTop("1in")
  • Minimal margin for web images: setMarginTop("10mm")

def setMarginRight(self, right)

Set the output canvas right margin.

Parameter:
  • right
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginRight("1in")
  • Minimal margin for web images: setMarginRight("10mm")

def setMarginBottom(self, bottom)

Set the output canvas bottom margin.

Parameter:
  • bottom
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginBottom("1in")
  • Minimal margin for web images: setMarginBottom("10mm")

def setMarginLeft(self, left)

Set the output canvas left margin.

Parameter:
  • left
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
Examples:
  • Wide margin for framing: setMarginLeft("1in")
  • Minimal margin for web images: setMarginLeft("10mm")

def setMargins(self, top, right, bottom, left)

Set the output canvas margins.

Parameters:
  • top - Set the output canvas top margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • right - Set the output canvas right margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • bottom - Set the output canvas bottom margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
  • left - Set the output canvas left margin.
    Constraint:
    • The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.

def setCanvasBackgroundColor(self, 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.

Parameter:
  • color
    Constraint:
    • The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color: setCanvasBackgroundColor("FF0000")
  • green color: setCanvasBackgroundColor("00ff00")
  • green color with 50% opacity: setCanvasBackgroundColor("00ff0080")

def setDpi(self, 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).

Parameter:
  • dpi (int) - The DPI value.
    Default:
    96
Example:
  • The DPI used for printers. 1 inch contains 300 points: setDpi(300)

Miscellaneous

def setDebugLog(self, 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.

Parameter:
  • value (bool) - Set to True to enable the debug logging.
    Default:
    False

def getDebugLogUrl(self) { return string; }

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

Returns:
string - The link to the debug log.

def getRemainingCreditCount(self) { return int; }

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:
int - The number of credits.

def getConsumedCreditCount(self) { return int; }

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

def getJobId(self) { return string; }

Get the job id.

Returns:
string - The unique job identifier.

def getOutputSize(self) { return int; }

Get the size of the output in bytes.

Returns:
int - The count of bytes.

def getVersion(self) { return string; }

Get the version details.

Returns:
string - API version, converter version, and client version.

def setTag(self, tag)

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

Parameter:
  • tag - A string with the custom tag.
Example:
  • Track job in analytics: setTag("client-1234")

def setHttpProxy(self, 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.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Corporate proxy server: setHttpProxy("myproxy.com:8080")
  • Direct IP proxy connection: setHttpProxy("113.25.84.10:33333")

def setHttpsProxy(self, 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.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Secure proxy for HTTPS: setHttpsProxy("myproxy.com:443")
  • Direct secure proxy IP: setHttpsProxy("113.25.84.10:44333")

API Client Options

def setConverterVersion(self, version)

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

Availability:
API client >= 5.0.0. See versioning.
Parameter:
  • version - The version identifier.
    Allowed Values:
    • 24.04 — Version 24.04.
    • 20.10 — Version 20.10.
    • 18.10 — Version 18.10.
    • latest — Version 20.10 is used.
    Default:
    24.04

def setUseHttp(self, value)

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Parameter:
  • value (bool) - Set to True to use HTTP.
    Default:
    False

def setClientUserAgent(self, agent)

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

Availability:
API client >= 6.4.0 See versioning.
Parameter:
  • agent - The user agent string.

def setUserAgent(self, agent)

Deprecated Replaced with: setClientUserAgent

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

Parameter:
  • agent - The user agent string.
    Default:
    pdfcrowd_python_client/6.5.3 (https://pdfcrowd.com)

def setProxy(self, host, port, user_name, password)

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

Parameters:
  • host - The proxy hostname.
  • port (int) - The proxy port.
  • user_name - The username.
  • password - The password.

def setRetryCount(self, 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.

Parameter:
  • count (int) - Number of retries.
    Default:
    1
Example:
  • Retry failed requests three times: setRetryCount(3)