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.
userName
Your username at Pdfcrowd.
apiKey
Your API key.

Conversion Input

func (client *ImageToImageClient) ConvertUrl(url string) ([]byte, error)
Convert an image.
url
The address of the image to convert.
The 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.
url
The address of the image to convert.
The supported protocols are http:// and https://.
outStream
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.
url
The address of the image to convert.
The supported protocols are http:// and https://.
filePath
The output file path. 
func (client *ImageToImageClient) ConvertFile(file string) ([]byte, error)
Convert a local file.
file
The path to a local file to convert.
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.
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. 
func (client *ImageToImageClient) ConvertFileToFile(file string, filePath string) error
Convert a local file and write the result to a local file.
file
The path to a local file to convert.
The file must exist and not be empty.
filePath
The output file path. 
func (client *ImageToImageClient) ConvertRawData(data []byte) ([]byte, error)
Convert raw data.
data
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.
data
The raw content to be converted.
outStream
The output stream that will contain the conversion output. 
func (client *ImageToImageClient) ConvertRawDataToFile(data []byte, filePath string) error
Convert raw data to a file.
data
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.
inStream
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.
inStream
The input stream with source data.
outStream
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.
inStream
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.
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.
resize
The resize percentage or new image dimensions.
Default: 100%
Examples:
  • SetResize("200%")
  • SetResize("1024x768") 
func (client *ImageToImageClient) SetRotate(rotate string) *ImageToImageClient
Rotate the image.
rotate
The rotation specified in degrees.
Default: 0 
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.
x
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • SetCropAreaX("-1in")
  • SetCropAreaX("2.5cm") 
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.
y
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • SetCropAreaY("-1in")
  • SetCropAreaY("2.5cm") 
func (client *ImageToImageClient) SetCropAreaWidth(width string) *ImageToImageClient
Set the width of the content area. It should be at least 1 inch.
width
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:
  • SetCropAreaWidth("8in")
  • SetCropAreaWidth("25cm") 
func (client *ImageToImageClient) SetCropAreaHeight(height string) *ImageToImageClient
Set the height of the content area. It should be at least 1 inch.
height
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:
  • SetCropAreaHeight("8in")
  • SetCropAreaHeight("25cm") 
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.
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".
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.
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.
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.
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.
value
Set to true to remove borders.
Default: false

Canvas Setup

func (client *ImageToImageClient) SetCanvasSize(size string) *ImageToImageClient
Set the output canvas size.
size
Allowed values:
  • A0
  • A1
  • A2
  • A3
  • A4
  • A5
  • A6
  • Letter
func (client *ImageToImageClient) SetCanvasWidth(width string) *ImageToImageClient
Set the output canvas width.
width
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetCanvasWidth("300mm")
  • SetCanvasWidth("9.5in") 
func (client *ImageToImageClient) SetCanvasHeight(height string) *ImageToImageClient
Set the output canvas height.
height
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetCanvasHeight("15.25in")
  • SetCanvasHeight("350mm") 
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.
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".
Examples:
  • SetCanvasDimensions("300mm", "350mm")
  • SetCanvasDimensions("9.5in", "15.25in")
  • SetCanvasDimensions("372mm", "520pt") 
func (client *ImageToImageClient) SetOrientation(orientation string) *ImageToImageClient
Set the output canvas orientation.
orientation
Allowed values:
  • landscape
  • portrait
Default: portrait 
func (client *ImageToImageClient) SetPosition(position string) *ImageToImageClient
Set the image position on the canvas.
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.
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.
top
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetMarginTop("1in")
  • SetMarginTop("2.5cm") 
func (client *ImageToImageClient) SetMarginRight(right string) *ImageToImageClient
Set the output canvas right margin.
right
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetMarginRight("1in")
  • SetMarginRight("2.5cm") 
func (client *ImageToImageClient) SetMarginBottom(bottom string) *ImageToImageClient
Set the output canvas bottom margin.
bottom
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetMarginBottom("1in")
  • SetMarginBottom("2.5cm") 
func (client *ImageToImageClient) SetMarginLeft(left string) *ImageToImageClient
Set the output canvas left margin.
left
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • SetMarginLeft("1in")
  • SetMarginLeft("2.5cm") 
func (client *ImageToImageClient) SetMargins(top string, right string, bottom string, left string) *ImageToImageClient
Set the output canvas margins.
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".
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.
color
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).
dpi
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.
value
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.
tag
A string with the custom tag.
Example:
  • SetTag("client-1234") 
func (client *ImageToImageClient) SetHttpProxy(proxy string) *ImageToImageClient
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • SetHttpProxy("myproxy.com:8080")
  • SetHttpProxy("113.25.84.10:33333") 
func (client *ImageToImageClient) SetHttpsProxy(proxy string) *ImageToImageClient
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • SetHttpsProxy("myproxy.com:443")
  • 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.
version
The version identifier.
Allowed values:
  • latest
    The latest converter version.
  • 20.10
    Version 20.10.
  • 18.10
    Version 18.10.
Default: 20.10 
func (client *ImageToImageClient) SetUseHttp(value bool) *ImageToImageClient
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
value
Set to true to use HTTP.
Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

func (client *ImageToImageClient) SetUserAgent(agent string) *ImageToImageClient
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent
The user agent string.
Default: pdfcrowd_go_client/5.18.1 (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.
host
The proxy hostname.
port
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.
count
Number of retries.
Default: 1
Example:
  • SetRetryCount(3)