# BarcodeCaptureDict

Simple object passed to capture to capture a Barcode.

Availability
0.8
0.8
9.2.0
Extends
Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# acceptedFormats

Availability
0.8
0.8
acceptedFormats :Array<Number>

An optional array of int constants detailing which barcode formats are accepted. Defaults to all formats. Check out the "Barcode Format Constants" section below to see the available int constants.


# allowedEANExtensions

Availability
0.8
0.8
9.2.0
allowedEANExtensions :Array<Number>

An optional int[] that specifies allowed extension lengths for EAN or UPC barcodes. https://zxing.github.io/zxing/apidocs/


# allowedLengths

Availability
0.8
0.8
9.2.0
allowedLengths :Array<Number>

An optional int[] that specifies allowed lengths of encoded data -- reject anything else. https://zxing.github.io/zxing/apidocs/


# animate

Availability
0.8
0.8
animate :Boolean

Indicates if the device should animate between the current activity and the camera activity when the current activity is in a different orientation than the camera. Default is true.

Default: true


# assumeCode39CheckDigit

Availability
0.8
0.8
9.2.0
assumeCode39CheckDigit :Boolean

An optional boolean which if true, will assume Code 39 codes employ a check digit. https://zxing.github.io/zxing/apidocs/

Please note that this hint only applies to FORMAT_CODE_39 format barcodes.


# assumeGS1

Availability
0.8
0.8
9.2.0
assumeGS1 :Boolean

An optional boolean to assume the barcode is being processed as a GS1 barcode, and modify behavior as needed. https://zxing.github.io/zxing/apidocs/

Please note that this hint only applies to FORMAT_CODE_128 format barcodes.


# characterSet

Availability
0.8
0.8
9.2.0
characterSet :String

An optional string that specifies what character encoding to use when decoding, where applicable https://zxing.github.io/zxing/apidocs/


# frameHeight

Availability
0.8
frameHeight :Number

Height of the rectangle that is shown in the scanner


# frameWidth

Availability
0.8
frameWidth :Number

Width of the rectangle that is shown in the scanner


# keepOpen

Availability
0.8
0.8
keepOpen :Boolean

Whether or not to keep the barcode scanner open after a barcode is recognized. Defaults to false. When set to true, "success" will fire once every time a barcode is recognized, up to two times per second. As such, it can fire multiple times for a single barcode!

Default: false


# overlay

Availability
0.8
0.8
overlay :Titanium.UI.View

The view to lay on top of the camera activity.


# preventRotation

Availability
0.8
0.8
preventRotation :Boolean

Prevent the scanner from auto-rotating when the device is rotated. Default: true

Default: true


# pureBarcode

Availability
0.8
0.8
9.2.0
pureBarcode :Boolean

An optional boolean to assume the image is a pure monochrome image of a barcode. https://zxing.github.io/zxing/apidocs/


# returnCodabarStartEnd

Availability
0.8
0.8
9.2.0
returnCodabarStartEnd :Boolean

An optional boolean which if true, will return the start and end digits in a Codabar barcode instead of stripping them. https://zxing.github.io/zxing/apidocs/

Please note that this hint only applies to FORMAT_CODABAR format barcodes.


# showCancel

Availability
0.8
showCancel :Boolean

Whether or not to include the default cancel button. Defaults to true.

Default: true


# showInfoText

Availability
0.8
showInfoText :Boolean

Whether to show informational text


# showRectangle

Availability
0.8
0.8
showRectangle :Boolean

Whether or not to include the default rectangle around the scanning area. Defaults to true.

Default: true


# tryHarder

Availability
0.8
0.8
9.2.0
tryHarder :Boolean

An optional boolean to spend more time to try to find a barcode; optimize for accuracy, not speed. https://zxing.github.io/zxing/apidocs/