BarcodeOptions (Pdftools SDK)

java.lang.Object
- com.pdftools.internal.NativeBase
- - com.pdftools.internal.NativeObject
  - - com.pdftools.ocr.BarcodeOptions

```
public class BarcodeOptions
extends NativeObject
```
Options for barcode and QR code recognition

Detected barcodes are written either to the document's XMP metadata (BarcodeHandling.EMBED) or to a caller-supplied XML stream (BarcodeHandling.EXTRACT), depending on getMode().

Barcode detection is performed by the OCR engine and depends on the type and settings of the engine as well as the parameters ImageOptions and PageOptions. To enable recognition, all three of the following must be configured: (1) pass an engine created with Engine.Create("barcodes") to Processor.process(com.pdftools.pdf.Document, com.pdftools.ocr.Engine, com.pdftools.sys.Stream); (2) set getMode() to BarcodeHandling.EMBED or BarcodeHandling.EXTRACT; (3) configure PageOptions or ImageOptions so that pages are submitted to the engine (typically PageOptions.getMode() = PageProcessingMode.ALL).

Setting getMode() alone has no effect.

Note: Available only on Windows x86 and x64.

Constructor Summary

Constructors
Constructor Description

BarcodeOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BarcodeHandling`	`getMode()`	How recognized barcodes are returned (Getter)
`void`	`setMode(BarcodeHandling value)`	How recognized barcodes are returned (Setter)
`void`	`setXmlOutputStream(Stream value)`	Stream that receives recognized barcodes as XML (Setter)

Methods inherited from class com.pdftools.internal.NativeObject
equals, hashCode

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarcodeOptions
```
public BarcodeOptions()
```
- Method Detail
  - getMode
```
public BarcodeHandling getMode()
```
    How recognized barcodes are returned (Getter)
    Default value: BarcodeHandling.NONE
  - setMode
```
public void setMode(BarcodeHandling value)
```
    How recognized barcodes are returned (Setter)
    Default value: BarcodeHandling.NONE
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null
  - setXmlOutputStream
```
public void setXmlOutputStream(Stream value)
```
    Stream that receives recognized barcodes as XML (Setter)
    
    Required if and only if getMode() is BarcodeHandling.EXTRACT.
    
    Default value: null