Image to Image / Golang Reference

class ImageToImageClient

All setter methods return ImageToImageClient object unless specified otherwise.

Constructor

func NewImageToImageClient(userName string, apiKey string) ImageToImageClient

Constructor for the PDFCrowd API client.

Parameters:
  • userName - Your username at PDFCrowd.
  • apiKey - Your API key.

Conversion Input

func (client *ImageToImageClient) ConvertUrl(url string) ([]byte, error)

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.

func (client *ImageToImageClient) ConvertUrlToStream(url string, outStream io.Writer) error

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://.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToImageClient) ConvertUrlToFile(url string, filePath string) error

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://.
  • filePath - The output file path.

func (client *ImageToImageClient) ConvertFile(file string) ([]byte, error)

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.

func (client *ImageToImageClient) ConvertFileToStream(file string, outStream io.Writer) error

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.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

func (client *ImageToImageClient) ConvertFileToFile(file string, filePath string) error

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.
  • filePath - The output file path.

func (client *ImageToImageClient) ConvertRawData(data []byte) ([]byte, error)

Convert raw data.

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

func (client *ImageToImageClient) ConvertRawDataToStream(data []byte, outStream io.Writer) error

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

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

func (client *ImageToImageClient) ConvertRawDataToFile(data []byte, filePath string) error

Convert raw data to a file.

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

func (client *ImageToImageClient) ConvertStream(inStream io.Reader) ([]byte, error)

Convert the contents of an input stream.

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

func (client *ImageToImageClient) ConvertStreamToStream(inStream io.Reader, outStream io.Writer) error

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

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

func (client *ImageToImageClient) ConvertStreamToFile(inStream io.Reader, filePath string) error

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

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

Conversion Format

func (client *ImageToImageClient) SetOutputFormat(outputFormat string) *ImageToImageClient

The format of the output file.

Parameter:
  • outputFormat
    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.

func (client *ImageToImageClient) SetResize(resize string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetRotate(rotate string) *ImageToImageClient

Rotate the image.

Parameter:
  • rotate - The rotation specified in degrees.

func (client *ImageToImageClient) SetCropAreaX(x string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCropAreaY(y string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCropAreaWidth(width string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCropAreaHeight(height string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCropArea(x string, y string, width string, height string) *ImageToImageClient

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.

func (client *ImageToImageClient) SetRemoveBorders(value bool) *ImageToImageClient

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

Parameter:
  • value (bool) - Set to true to remove borders.
    Default:
    false

Canvas Setup

func (client *ImageToImageClient) SetCanvasSize(size string) *ImageToImageClient

Set the output canvas size.

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

func (client *ImageToImageClient) SetCanvasWidth(width string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCanvasHeight(height string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetCanvasDimensions(width string, height string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetOrientation(orientation string) *ImageToImageClient

Set the output canvas orientation.

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

func (client *ImageToImageClient) SetPosition(position string) *ImageToImageClient

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

func (client *ImageToImageClient) SetPrintCanvasMode(mode string) *ImageToImageClient

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

func (client *ImageToImageClient) SetMarginTop(top string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetMarginRight(right string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetMarginBottom(bottom string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetMarginLeft(left string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetMargins(top string, right string, bottom string, left string) *ImageToImageClient

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'.

func (client *ImageToImageClient) SetCanvasBackgroundColor(color string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetDpi(dpi int) *ImageToImageClient

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

func (client *ImageToImageClient) SetDebugLog(value bool) *ImageToImageClient

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

func (client *ImageToImageClient) GetDebugLogUrl() string

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

Returns:
string - The link to the debug log.

func (client *ImageToImageClient) GetRemainingCreditCount() 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.

func (client *ImageToImageClient) GetConsumedCreditCount() int

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

func (client *ImageToImageClient) GetJobId() string

Get the job id.

Returns:
string - The unique job identifier.

func (client *ImageToImageClient) GetOutputSize() int

Get the size of the output in bytes.

Returns:
int - The count of bytes.

func (client *ImageToImageClient) GetVersion() string

Get the version details.

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

func (client *ImageToImageClient) SetTag(tag string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetHttpProxy(proxy string) *ImageToImageClient

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")

func (client *ImageToImageClient) SetHttpsProxy(proxy string) *ImageToImageClient

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

func (client *ImageToImageClient) SetConverterVersion(version string) *ImageToImageClient

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

func (client *ImageToImageClient) SetUseHttp(value bool) *ImageToImageClient

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

Parameter:
  • value (bool) - Set to true to use HTTP.
    Default:
    false

func (client *ImageToImageClient) SetClientUserAgent(agent string) *ImageToImageClient

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.

func (client *ImageToImageClient) SetUserAgent(agent string) *ImageToImageClient

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_go_client/6.5.3 (https://pdfcrowd.com)

func (client *ImageToImageClient) SetProxy(host string, port int, userName string, password string) *ImageToImageClient

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.
  • userName - The username.
  • password - The password.

func (client *ImageToImageClient) SetRetryCount(count int) *ImageToImageClient

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)