Constructor and Description |
---|
PdfToImageClient(String userName,
String apiKey)
Constructor for the Pdfcrowd API client.
|
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 |
getPageCount()
Get the number of pages in the output document.
|
int |
getRemainingCreditCount()
Get the number of conversion credits available in your account.
|
String |
getVersion()
Get the version details.
|
boolean |
isZippedOutput()
A helper method to determine if the output file from a conversion process is a zip archive.
|
Pdfcrowd.PdfToImageClient |
setCropArea(int x,
int y,
int width,
int height)
Set the crop area.
|
Pdfcrowd.PdfToImageClient |
setCropAreaHeight(int height)
Set the height of the crop area in points.
|
Pdfcrowd.PdfToImageClient |
setCropAreaWidth(int width)
Set the width of the crop area in points.
|
Pdfcrowd.PdfToImageClient |
setCropAreaX(int x)
Set the top left X coordinate of the crop area in points.
|
Pdfcrowd.PdfToImageClient |
setCropAreaY(int y)
Set the top left Y coordinate of the crop area in points.
|
Pdfcrowd.PdfToImageClient |
setDebugLog(boolean value)
Turn on the debug logging.
|
Pdfcrowd.PdfToImageClient |
setDpi(int dpi)
Set the output graphics DPI.
|
Pdfcrowd.PdfToImageClient |
setForceZip(boolean value)
Enforces the zip output format.
|
Pdfcrowd.PdfToImageClient |
setHttpProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme.
|
Pdfcrowd.PdfToImageClient |
setHttpsProxy(String proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme.
|
Pdfcrowd.PdfToImageClient |
setOutputFormat(String outputFormat)
The format of the output file.
|
Pdfcrowd.PdfToImageClient |
setPdfPassword(String password)
Password to open the encrypted PDF file.
|
Pdfcrowd.PdfToImageClient |
setPrintPageRange(String pages)
Set the page range to print.
|
Pdfcrowd.PdfToImageClient |
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.PdfToImageClient |
setRetryCount(int count)
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
|
Pdfcrowd.PdfToImageClient |
setTag(String tag)
Tag the conversion with a custom value.
|
Pdfcrowd.PdfToImageClient |
setUseCropbox(boolean value)
Use the crop box rather than media box.
|
Pdfcrowd.PdfToImageClient |
setUseGrayscale(boolean value)
Generate a grayscale image.
|
Pdfcrowd.PdfToImageClient |
setUseHttp(boolean value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
|
Pdfcrowd.PdfToImageClient |
setUserAgent(String agent)
Set a custom user agent HTTP header.
|
public byte[] convertUrl(String url)
url
- The address of the image to convert. The supported protocols are http:// and https://.public void convertUrlToStream(String url, OutputStream outStream)
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.public void convertUrlToFile(String url, String filePath) throws IOException
url
- The address of the image to convert. The supported protocols are http:// and https://.filePath
- The output file path. The string must not be empty.IOException
public byte[] convertFile(String file)
file
- The path to a local file to convert.public void convertFileToStream(String file, OutputStream outStream)
file
- The path to a local file to convert.outStream
- The output stream that will contain the conversion output.public void convertFileToFile(String file, String filePath) throws IOException
file
- The path to a local file to convert.filePath
- The output file path. The string must not be empty.IOException
public byte[] convertRawData(byte[] data)
data
- The raw content to be converted.public void convertRawDataToStream(byte[] data, OutputStream outStream)
data
- The raw content to be converted.outStream
- The output stream that will contain the conversion output.public void convertRawDataToFile(byte[] data, String filePath) throws IOException
data
- The raw content to be converted.filePath
- The output file path. The string must not be empty.IOException
public byte[] convertStream(InputStream inStream) throws IOException
inStream
- The input stream with source data.IOException
public void convertStreamToStream(InputStream inStream, OutputStream outStream) throws IOException
inStream
- The input stream with source data.outStream
- The output stream that will contain the conversion output.IOException
public void convertStreamToFile(InputStream inStream, String filePath) throws IOException
inStream
- The input stream with source data.filePath
- The output file path. The string must not be empty.IOException
public Pdfcrowd.PdfToImageClient setOutputFormat(String outputFormat)
outputFormat
- Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.public Pdfcrowd.PdfToImageClient setPdfPassword(String password)
password
- The input PDF password.public Pdfcrowd.PdfToImageClient setPrintPageRange(String pages)
pages
- A comma separated list of page numbers or ranges.public Pdfcrowd.PdfToImageClient setDpi(int dpi)
dpi
- The DPI value.public boolean isZippedOutput()
public Pdfcrowd.PdfToImageClient setForceZip(boolean value)
value
- Set to true to get the output as a zip archive.public Pdfcrowd.PdfToImageClient setUseCropbox(boolean value)
value
- Set to true to use crop box.public Pdfcrowd.PdfToImageClient setCropAreaX(int x)
x
- Must be a positive integer number or 0.public Pdfcrowd.PdfToImageClient setCropAreaY(int y)
y
- Must be a positive integer number or 0.public Pdfcrowd.PdfToImageClient setCropAreaWidth(int width)
width
- Must be a positive integer number or 0.public Pdfcrowd.PdfToImageClient setCropAreaHeight(int height)
height
- Must be a positive integer number or 0.public Pdfcrowd.PdfToImageClient setCropArea(int x, int y, int width, int height)
x
- Set the top left X coordinate of the crop area in points. Must be a positive integer number or 0.y
- Set the top left Y coordinate of the crop area in points. Must be a positive integer number or 0.width
- Set the width of the crop area in points. Must be a positive integer number or 0.height
- Set the height of the crop area in points. Must be a positive integer number or 0.public Pdfcrowd.PdfToImageClient setUseGrayscale(boolean value)
value
- Set to true to generate a grayscale image.public Pdfcrowd.PdfToImageClient setDebugLog(boolean value)
value
- Set to true to enable the debug logging.public String getDebugLogUrl()
public int getRemainingCreditCount()
public int getConsumedCreditCount()
public String getJobId()
public int getPageCount()
public int getOutputSize()
public String getVersion()
public Pdfcrowd.PdfToImageClient setTag(String tag)
tag
- A string with the custom tag.public Pdfcrowd.PdfToImageClient setHttpProxy(String proxy)
proxy
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.public Pdfcrowd.PdfToImageClient setHttpsProxy(String proxy)
proxy
- The value must have format DOMAIN_OR_IP_ADDRESS:PORT.public Pdfcrowd.PdfToImageClient setUseHttp(boolean value)
value
- Set to true to use HTTP.public Pdfcrowd.PdfToImageClient setUserAgent(String agent)
agent
- The user agent string.public Pdfcrowd.PdfToImageClient setProxy(String host, int port, String userName, String password)
host
- The proxy hostname.port
- The proxy port.userName
- The username.password
- The password.public Pdfcrowd.PdfToImageClient setRetryCount(int count)
count
- Number of retries.Copyright © 2024. All rights reserved.