PDF to Image / Golang Reference

class PdfToImageClient

All setter methods return PdfToImageClient object unless specified otherwise.

Constructor

func NewPdfToImageClient(userName string, apiKey string) PdfToImageClient

Constructor for the PDFCrowd API client.

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

Conversion Input

func (client *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) 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 *PdfToImageClient) SetOutputFormat(outputFormat string) *PdfToImageClient

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

General Options

func (client *PdfToImageClient) SetPdfPassword(password string) *PdfToImageClient

Password to open the encrypted PDF file.

Parameter:
  • password - The input PDF password.

func (client *PdfToImageClient) SetPrintPageRange(pages string) *PdfToImageClient

Set the page range to print.

Parameter:
  • pages
    Constraint:
    • A comma separated list of page numbers or ranges.
Examples:
  • Just the second page is printed: SetPrintPageRange("2")
  • The first and the third page are printed: SetPrintPageRange("1,3")
  • Everything except the first page is printed: SetPrintPageRange("2-")
  • Just first 3 pages are printed: SetPrintPageRange("-3")
  • Pages 3, 6, 7, 8 and 9 are printed: SetPrintPageRange("3,6-9")

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

Set the output graphics DPI.

Availability:
API client >= 5.16.0, converter >= 20.10. See versioning.
Parameter:
  • dpi (int) - The DPI value.
    Default:
    144

func (client *PdfToImageClient) IsZippedOutput() bool

A helper method to determine if the output file from a conversion process is a zip archive. The conversion output can be either a single image file or a zip file containing one or more image files. This method should be called after the conversion has been successfully completed.

Returns:
bool - True if the conversion output is a zip archive, otherwise False.

func (client *PdfToImageClient) SetForceZip(value bool) *PdfToImageClient

Enforces the zip output format.

Parameter:
  • value (bool) - Set to true to get the output as a zip archive.
    Default:
    false

func (client *PdfToImageClient) SetUseCropbox(value bool) *PdfToImageClient

Use the crop box rather than media box.

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

func (client *PdfToImageClient) SetCropAreaX(x int) *PdfToImageClient

Set the top left X coordinate of the crop area in points.

Parameter:
  • x (int)
    Constraint:
    • Must be a positive integer or 0.
Example:
  • Start crop at 1.4 inches from left: SetCropAreaX(100)

func (client *PdfToImageClient) SetCropAreaY(y int) *PdfToImageClient

Set the top left Y coordinate of the crop area in points.

Parameter:
  • y (int)
    Constraint:
    • Must be a positive integer or 0.
Example:
  • Start crop at 1.4 inches from top: SetCropAreaY(100)

func (client *PdfToImageClient) SetCropAreaWidth(width int) *PdfToImageClient

Set the width of the crop area in points.

Parameter:
  • width (int)
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page width.
Example:
  • Narrow 1.4 inch crop width: SetCropAreaWidth(100)

func (client *PdfToImageClient) SetCropAreaHeight(height int) *PdfToImageClient

Set the height of the crop area in points.

Parameter:
  • height (int)
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page height.
Example:
  • Small 1.4 inch crop height: SetCropAreaHeight(100)

func (client *PdfToImageClient) SetCropArea(x int, y int, width int, height int) *PdfToImageClient

Set the crop area. It allows to extract just a part of a PDF page.

Parameters:
  • x (int) - Set the top left X coordinate of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
  • y (int) - Set the top left Y coordinate of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
  • width (int) - Set the width of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page width.
  • height (int) - Set the height of the crop area in points.
    Constraint:
    • Must be a positive integer or 0.
    Default:
    PDF page height.

func (client *PdfToImageClient) SetUseGrayscale(value bool) *PdfToImageClient

Generate a grayscale image.

Parameter:
  • value (bool) - Set to true to generate a grayscale image.
    Default:
    false

Miscellaneous

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

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 *PdfToImageClient) GetDebugLogUrl() string

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

Returns:
string - The link to the debug log.

func (client *PdfToImageClient) 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 *PdfToImageClient) GetConsumedCreditCount() int

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

func (client *PdfToImageClient) GetJobId() string

Get the job id.

Returns:
string - The unique job identifier.

func (client *PdfToImageClient) GetPageCount() int

Get the number of pages in the output document.

Returns:
int - The page count.

func (client *PdfToImageClient) GetOutputSize() int

Get the size of the output in bytes.

Returns:
int - The count of bytes.

func (client *PdfToImageClient) GetVersion() string

Get the version details.

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

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

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 *PdfToImageClient) SetHttpProxy(proxy string) *PdfToImageClient

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 *PdfToImageClient) SetHttpsProxy(proxy string) *PdfToImageClient

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 *PdfToImageClient) SetUseHttp(value bool) *PdfToImageClient

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 *PdfToImageClient) SetClientUserAgent(agent string) *PdfToImageClient

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 *PdfToImageClient) SetUserAgent(agent string) *PdfToImageClient

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

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

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 *PdfToImageClient) SetRetryCount(count int) *PdfToImageClient

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)