Summary: Methods | Inherited Methods | [Expand All]
public class

# BarcodeModule

extends Object

java.lang.Object
↳ | com.pdftron.pdf.BarcodeModule

## Class Overview

The class BarcodeModule. static interface to Apryse SDK's barcode extraction functionality

## Summary

Public Methods
static void | extractBarcodes(PDFDoc src, String output_file_path) Perform barcode extraction on a PDF.
static void | extractBarcodes(PDFDoc src, String output_file_path, BarcodeOptions options) Perform barcode extraction on a PDF.
static String | extractBarcodesAsString(PDFDoc src) Perform barcode extraction on a PDF.
static String | extractBarcodesAsString(PDFDoc src, BarcodeOptions options) Perform barcode extraction on a PDF.
static boolean | isModuleAvailable() Find out whether the Barcode Extraction Module is available (and licensed).

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Methods

#### public static void extractBarcodes (PDFDoc src, String output_file_path)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and save a JSON array of detected barcodes to the specified file. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

##### Parameters

src | The source document.
output_file_path | The path to the output file.

##### Throws

PDFNetException |

#### public static void extractBarcodes (PDFDoc src, String output_file_path, BarcodeOptions options)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and save a JSON array of detected barcodes to the specified file. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

##### Parameters

src | The source document.
output_file_path | The path to the output file.
options | Barcode options (optional).

##### Throws

PDFNetException |

#### public static String extractBarcodesAsString (PDFDoc src)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and return a JSON array of detected barcodes as a string. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

##### Parameters

src | The source document.

##### Returns

- JSON string representing barcode extraction results.

##### Throws

PDFNetException |

#### public static String extractBarcodesAsString (PDFDoc src, BarcodeOptions options)

Perform barcode extraction on a PDF. Scan the PDF for barcodes, and return a JSON array of detected barcodes as a string. By default, this will search for all supported barcode types in all orientations. The time required to process the document will depend on the number of barcode types and orientations to search for. Thus, the default behavior is the slowest. To improve speed, specify a subset of barcode types and orientations to search for using the options parameter. Very small barcodes may not be detected. While there is no hard limit to barcode size, accuracy will begin to decrease as barcodes get smaller. The smallest barcode that can be detected will depend on a number of factors, including page size, barcode type, and (if applicable) image quality.

##### Parameters

src | The source document.
options | Barcode options (optional).

##### Returns

- JSON string representing barcode extraction results.

##### Throws

PDFNetException |

#### public static boolean isModuleAvailable ()

Find out whether the Barcode Extraction Module is available (and licensed).

##### Returns

- Returns true if barcode extraction can be performed.

##### Throws

PDFNetException |