All Implemented Interfaces:: android.os.Parcelable


public final class BarcodeScannerJsonConfiguration
 implements Parcelable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`version`
`private String`	`screen`
`private List<JsonBarcodeDocumentFormat>`	`acceptedDocumentFormats`
`private JsonBarcodesExtensionFilter`	`barcodesExtensionFilter`
`private JsonColor`	`cameraOverlayColor`
`private JsonCameraModule`	`cameraModule`
`private Double`	`cameraZoomFactor`
`private String`	`cancelButtonTitle`
`private JsonEngineMode`	`engineMode`
`private String`	`enableCameraButtonTitle`
`private String`	`enableCameraExplanationText`
`private JsonColor`	`finderLineColor`
`private Double`	`finderLineWidth`
`private String`	`finderTextHint`
`private JsonColor`	`finderTextHintColor`
`private JsonAspectRatio`	`finderAspectRatio`
`private JsonColor`	`flashButtonInactiveColor`
`private Boolean`	`flashEnabled`
`private Boolean`	`touchToFocusEnabled`
`private JsonOrientationLockMode`	`orientationLockMode`
`private Integer`	`minimumTextLength`
`private Integer`	`maximumTextLength`
`private Boolean`	`minFocusDistanceLock`
`private Integer`	`minimum1DBarcodesQuietZone`
`private Boolean`	`stripCheckDigits`
`private Boolean`	`useIATA2OF5Checksum`
`private Boolean`	`useCode11Checksum`
`private Boolean`	`successBeepEnabled`
`private JsonColor`	`topBarBackgroundColor`
`private JsonColor`	`topBarButtonsColor`
`private List<JsonBarcodeFormat>`	`barcodeFormats`
`private Boolean`	`useButtonsAllCaps`
`private Boolean`	`replaceCancelButtonWithIcon`
`private JsonCameraPreviewMode`	`cameraPreviewMode`
`private JsonZoomRange`	`cameraZoomRange`
`private Integer`	`autoCancelTimeout`
`private JsonGs1HandlingMode`	`gs1HandlingMode`
`private JsonMSIPlesseyChecksumAlgorithm`	`msiPlesseyChecksumAlgorithm`
`private JsonAustraliaPostCustomerFormat`	`australiaPostCustomerFormat`
`private Boolean`	`lowPowerMode`
`private JsonBarcodeImageGenerationType`	`barcodeImageGenerationType`
`private Double`	`initialScanDelay`
`private Double`	`delayAfterScan`
`private Boolean`	`viewFinderEnabled`
`private JsonConfirmationDialogConfiguration`	`confirmationDialogConfiguration`
`private JsonSelectionOverlayConfiguration`	`overlayConfiguration`

Constructor Summary

Constructors
Constructor	Description
BarcodeScannerJsonConfiguration(String version, String screen, List<JsonBarcodeDocumentFormat> acceptedDocumentFormats, JsonBarcodesExtensionFilter barcodesExtensionFilter, JsonColor cameraOverlayColor, JsonCameraModule cameraModule, Double cameraZoomFactor, String cancelButtonTitle, JsonEngineMode engineMode, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, String finderTextHint, JsonColor finderTextHintColor, JsonAspectRatio finderAspectRatio, JsonColor flashButtonInactiveColor, Boolean flashEnabled, Boolean touchToFocusEnabled, JsonOrientationLockMode orientationLockMode, Integer minimumTextLength, Integer maximumTextLength, Boolean minFocusDistanceLock, Integer minimum1DBarcodesQuietZone, Boolean stripCheckDigits, Boolean useIATA2OF5Checksum, Boolean useCode11Checksum, Boolean successBeepEnabled, JsonColor topBarBackgroundColor, JsonColor topBarButtonsColor, List<JsonBarcodeFormat> barcodeFormats, Boolean useButtonsAllCaps, Boolean replaceCancelButtonWithIcon, JsonCameraPreviewMode cameraPreviewMode, JsonZoomRange cameraZoomRange, Integer autoCancelTimeout, JsonGs1HandlingMode gs1HandlingMode, JsonMSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm, JsonAustraliaPostCustomerFormat australiaPostCustomerFormat, Boolean lowPowerMode, JsonBarcodeImageGenerationType barcodeImageGenerationType, Double initialScanDelay, Double delayAfterScan, Boolean viewFinderEnabled, JsonConfirmationDialogConfiguration confirmationDialogConfiguration, JsonSelectionOverlayConfiguration overlayConfiguration)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	A version of the configuration object
`final Unit`	`setVersion(String version)`	A version of the configuration object
`final String`	`getScreen()`	The configuration object should be applied for this screen
`final Unit`	`setScreen(String screen)`	The configuration object should be applied for this screen
`final List<JsonBarcodeDocumentFormat>`	`getAcceptedDocumentFormats()`	An optional array of barcode document formats that act as a detection filter.
`final Unit`	`setAcceptedDocumentFormats(List<JsonBarcodeDocumentFormat> acceptedDocumentFormats)`	An optional array of barcode document formats that act as a detection filter.
`final JsonBarcodesExtensionFilter`	`getBarcodesExtensionFilter()`	The extension filter for EAN and UPC barcodes.
`final Unit`	`setBarcodesExtensionFilter(JsonBarcodesExtensionFilter barcodesExtensionFilter)`	The extension filter for EAN and UPC barcodes.
`final JsonColor`	`getCameraOverlayColor()`	Background color of the detection overlay.
`final Unit`	`setCameraOverlayColor(JsonColor cameraOverlayColor)`	Background color of the detection overlay.
`final JsonCameraModule`	`getCameraModule()`	The camera module to be used for barcode scanning.
`final Unit`	`setCameraModule(JsonCameraModule cameraModule)`	The camera module to be used for barcode scanning.
`final Double`	`getCameraZoomFactor()`	The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in.
`final Unit`	`setCameraZoomFactor(Double cameraZoomFactor)`	The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in.
`final String`	`getCancelButtonTitle()`	String being displayed on the cancel button.
`final Unit`	`setCancelButtonTitle(String cancelButtonTitle)`	String being displayed on the cancel button.
`final JsonEngineMode`	`getEngineMode()`	The engine mode to be used for barcode scanning.
`final Unit`	`setEngineMode(JsonEngineMode engineMode)`	The engine mode to be used for barcode scanning.
`final String`	`getEnableCameraButtonTitle()`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`final Unit`	`setEnableCameraButtonTitle(String enableCameraButtonTitle)`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`final String`	`getEnableCameraExplanationText()`	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
`final Unit`	`setEnableCameraExplanationText(String enableCameraExplanationText)`	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
`final JsonColor`	`getFinderLineColor()`	Foreground color of the detection overlay.
`final Unit`	`setFinderLineColor(JsonColor finderLineColor)`	Foreground color of the detection overlay.
`final Double`	`getFinderLineWidth()`	Width of finder frame border.
`final Unit`	`setFinderLineWidth(Double finderLineWidth)`	Width of finder frame border.
`final String`	`getFinderTextHint()`	String being displayed as description.
`final Unit`	`setFinderTextHint(String finderTextHint)`	String being displayed as description.
`final JsonColor`	`getFinderTextHintColor()`	Foreground color of the description label.
`final Unit`	`setFinderTextHintColor(JsonColor finderTextHintColor)`	Foreground color of the description label.
`final JsonAspectRatio`	`getFinderAspectRatio()`	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
`final Unit`	`setFinderAspectRatio(JsonAspectRatio finderAspectRatio)`	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
`final JsonColor`	`getFlashButtonInactiveColor()`	Foreground color of the flash button when flash is off.
`final Unit`	`setFlashButtonInactiveColor(JsonColor flashButtonInactiveColor)`	Foreground color of the flash button when flash is off.
`final Boolean`	`getFlashEnabled()`	Whether flash is toggled on or off.
`final Unit`	`setFlashEnabled(Boolean flashEnabled)`	Whether flash is toggled on or off.
`final Boolean`	`getTouchToFocusEnabled()`	Whether touch-to-focus is enabled on camera preview.
`final Unit`	`setTouchToFocusEnabled(Boolean touchToFocusEnabled)`	Whether touch-to-focus is enabled on camera preview.
`final JsonOrientationLockMode`	`getOrientationLockMode()`	UI Interface orientation lock mode
`final Unit`	`setOrientationLockMode(JsonOrientationLockMode orientationLockMode)`	UI Interface orientation lock mode
`final Integer`	`getMinimumTextLength()`	Optional minimum required text length of the detected barcode.
`final Unit`	`setMinimumTextLength(Integer minimumTextLength)`	Optional minimum required text length of the detected barcode.
`final Integer`	`getMaximumTextLength()`	Optional maximum text length of the detected barcode.
`final Unit`	`setMaximumTextLength(Integer maximumTextLength)`	Optional maximum text length of the detected barcode.
`final Boolean`	`getMinFocusDistanceLock()`	Lock focus distance withing minimum possible range
`final Unit`	`setMinFocusDistanceLock(Boolean minFocusDistanceLock)`	Lock focus distance withing minimum possible range
`final Integer`	`getMinimum1DBarcodesQuietZone()`	Optional minimum required quiet zone on the barcode.
`final Unit`	`setMinimum1DBarcodesQuietZone(Integer minimum1DBarcodesQuietZone)`	Optional minimum required quiet zone on the barcode.
`final Boolean`	`getStripCheckDigits()`	With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
`final Unit`	`setStripCheckDigits(Boolean stripCheckDigits)`	With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes.
`final Boolean`	`getUseIATA2OF5Checksum()`	If `true`, the optional check digit for IATA_2_OF_5 codes is used in validation.
`final Unit`	`setUseIATA2OF5Checksum(Boolean useIATA2OF5Checksum)`	If `true`, the optional check digit for IATA_2_OF_5 codes is used in validation.
`final Boolean`	`getUseCode11Checksum()`	If `true`, the optional check digit for CODE_11 codes is used in validation.
`final Unit`	`setUseCode11Checksum(Boolean useCode11Checksum)`	If `true`, the optional check digit for CODE_11 codes is used in validation.
`final Boolean`	`getSuccessBeepEnabled()`	Whether scanner screen should make a sound on successful barcode or MRZ detection.
`final Unit`	`setSuccessBeepEnabled(Boolean successBeepEnabled)`	Whether scanner screen should make a sound on successful barcode or MRZ detection.
`final JsonColor`	`getTopBarBackgroundColor()`	Background color of the top bar.
`final Unit`	`setTopBarBackgroundColor(JsonColor topBarBackgroundColor)`	Background color of the top bar.
`final JsonColor`	`getTopBarButtonsColor()`	Foreground color of the cancel button.
`final Unit`	`setTopBarButtonsColor(JsonColor topBarButtonsColor)`	Foreground color of the cancel button.
`final List<JsonBarcodeFormat>`	`getBarcodeFormats()`	Accepted barcode formats
`final Unit`	`setBarcodeFormats(List<JsonBarcodeFormat> barcodeFormats)`	Accepted barcode formats
`final Boolean`	`getUseButtonsAllCaps()`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final Unit`	`setUseButtonsAllCaps(Boolean useButtonsAllCaps)`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final Boolean`	`getReplaceCancelButtonWithIcon()`	If `true`, replaces the cancel button in the top bar with a back arrow icon.
`final Unit`	`setReplaceCancelButtonWithIcon(Boolean replaceCancelButtonWithIcon)`	If `true`, replaces the cancel button in the top bar with a back arrow icon.
`final JsonCameraPreviewMode`	`getCameraPreviewMode()`	Preview mode of the camera.
`final Unit`	`setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)`	Preview mode of the camera.
`final JsonZoomRange`	`getCameraZoomRange()`	The range of valid camera zoom factors.
`final Unit`	`setCameraZoomRange(JsonZoomRange cameraZoomRange)`	The range of valid camera zoom factors.
`final Integer`	`getAutoCancelTimeout()`	Sets auto close timer in seconds.
`final Unit`	`setAutoCancelTimeout(Integer autoCancelTimeout)`	Sets auto close timer in seconds.
`final JsonGs1HandlingMode`	`getGs1HandlingMode()`	The GS1 handling mode.
`final Unit`	`setGs1HandlingMode(JsonGs1HandlingMode gs1HandlingMode)`	The GS1 handling mode.
`final JsonMSIPlesseyChecksumAlgorithm`	`getMsiPlesseyChecksumAlgorithm()`	The checksum algorithm for MSI Plessey barcodes.
`final Unit`	`setMsiPlesseyChecksumAlgorithm(JsonMSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm)`	The checksum algorithm for MSI Plessey barcodes.
`final JsonAustraliaPostCustomerFormat`	`getAustraliaPostCustomerFormat()`	The customer format used in AUSTRALIA_POST codes.
`final Unit`	`setAustraliaPostCustomerFormat(JsonAustraliaPostCustomerFormat australiaPostCustomerFormat)`	The customer format used in AUSTRALIA_POST codes.
`final Boolean`	`getLowPowerMode()`	If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.
`final Unit`	`setLowPowerMode(Boolean lowPowerMode)`	If `true`, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.
`final JsonBarcodeImageGenerationType`	`getBarcodeImageGenerationType()`	The type of barcode image generation.
`final Unit`	`setBarcodeImageGenerationType(JsonBarcodeImageGenerationType barcodeImageGenerationType)`	The type of barcode image generation.
`final Double`	`getInitialScanDelay()`	Scanning delay after scanner appearance in seconds.
`final Unit`	`setInitialScanDelay(Double initialScanDelay)`	Scanning delay after scanner appearance in seconds.
`final Double`	`getDelayAfterScan()`	Freezes a preview after a scan for a given amount of seconds.
`final Unit`	`setDelayAfterScan(Double delayAfterScan)`	Freezes a preview after a scan for a given amount of seconds.
`final Boolean`	`getViewFinderEnabled()`	Display the region of interest.
`final Unit`	`setViewFinderEnabled(Boolean viewFinderEnabled)`	Display the region of interest.
`final JsonConfirmationDialogConfiguration`	`getConfirmationDialogConfiguration()`	The confirmation dialog configuration.
`final Unit`	`setConfirmationDialogConfiguration(JsonConfirmationDialogConfiguration confirmationDialogConfiguration)`	The confirmation dialog configuration.
`final JsonSelectionOverlayConfiguration`	`getOverlayConfiguration()`	The selection overlay configuration.
`final Unit`	`setOverlayConfiguration(JsonSelectionOverlayConfiguration overlayConfiguration)`	The selection overlay configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarcodeScannerJsonConfiguration
```
BarcodeScannerJsonConfiguration(String version, String screen, List<JsonBarcodeDocumentFormat> acceptedDocumentFormats, JsonBarcodesExtensionFilter barcodesExtensionFilter, JsonColor cameraOverlayColor, JsonCameraModule cameraModule, Double cameraZoomFactor, String cancelButtonTitle, JsonEngineMode engineMode, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, String finderTextHint, JsonColor finderTextHintColor, JsonAspectRatio finderAspectRatio, JsonColor flashButtonInactiveColor, Boolean flashEnabled, Boolean touchToFocusEnabled, JsonOrientationLockMode orientationLockMode, Integer minimumTextLength, Integer maximumTextLength, Boolean minFocusDistanceLock, Integer minimum1DBarcodesQuietZone, Boolean stripCheckDigits, Boolean useIATA2OF5Checksum, Boolean useCode11Checksum, Boolean successBeepEnabled, JsonColor topBarBackgroundColor, JsonColor topBarButtonsColor, List<JsonBarcodeFormat> barcodeFormats, Boolean useButtonsAllCaps, Boolean replaceCancelButtonWithIcon, JsonCameraPreviewMode cameraPreviewMode, JsonZoomRange cameraZoomRange, Integer autoCancelTimeout, JsonGs1HandlingMode gs1HandlingMode, JsonMSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm, JsonAustraliaPostCustomerFormat australiaPostCustomerFormat, Boolean lowPowerMode, JsonBarcodeImageGenerationType barcodeImageGenerationType, Double initialScanDelay, Double delayAfterScan, Boolean viewFinderEnabled, JsonConfirmationDialogConfiguration confirmationDialogConfiguration, JsonSelectionOverlayConfiguration overlayConfiguration)
```
- Method Detail
  - getVersion
```
 final String getVersion()
```
    A version of the configuration object
  - setVersion
```
 final Unit setVersion(String version)
```
    A version of the configuration object
  - getScreen
```
 final String getScreen()
```
    The configuration object should be applied for this screen
  - setScreen
```
 final Unit setScreen(String screen)
```
    The configuration object should be applied for this screen
  - getAcceptedDocumentFormats
```
 final List<JsonBarcodeDocumentFormat> getAcceptedDocumentFormats()
```
    An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
  - setAcceptedDocumentFormats
```
 final Unit setAcceptedDocumentFormats(List<JsonBarcodeDocumentFormat> acceptedDocumentFormats)
```
    An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
  - getBarcodesExtensionFilter
```
 final JsonBarcodesExtensionFilter getBarcodesExtensionFilter()
```
    The extension filter for EAN and UPC barcodes.
  - setBarcodesExtensionFilter
```
 final Unit setBarcodesExtensionFilter(JsonBarcodesExtensionFilter barcodesExtensionFilter)
```
    The extension filter for EAN and UPC barcodes.
  - getCameraOverlayColor
```
 final JsonColor getCameraOverlayColor()
```
    Background color of the detection overlay.
  - setCameraOverlayColor
```
 final Unit setCameraOverlayColor(JsonColor cameraOverlayColor)
```
    Background color of the detection overlay.
  - getCameraModule
```
 final JsonCameraModule getCameraModule()
```
    The camera module to be used for barcode scanning. The default value is BACK.
  - setCameraModule
```
 final Unit setCameraModule(JsonCameraModule cameraModule)
```
    The camera module to be used for barcode scanning. The default value is BACK.
  - getCameraZoomFactor
```
 final Double getCameraZoomFactor()
```
    The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.
  - setCameraZoomFactor
```
 final Unit setCameraZoomFactor(Double cameraZoomFactor)
```
    The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.
  - getCancelButtonTitle
```
 final String getCancelButtonTitle()
```
    String being displayed on the cancel button.
  - setCancelButtonTitle
```
 final Unit setCancelButtonTitle(String cancelButtonTitle)
```
    String being displayed on the cancel button.
  - getEngineMode
```
 final JsonEngineMode getEngineMode()
```
    The engine mode to be used for barcode scanning. The default value is NEXT_GEN.
  - setEngineMode
```
 final Unit setEngineMode(JsonEngineMode engineMode)
```
    The engine mode to be used for barcode scanning. The default value is NEXT_GEN.
  - getEnableCameraButtonTitle
```
 final String getEnableCameraButtonTitle()
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - setEnableCameraButtonTitle
```
 final Unit setEnableCameraButtonTitle(String enableCameraButtonTitle)
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - getEnableCameraExplanationText
```
 final String getEnableCameraExplanationText()
```
    Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  - setEnableCameraExplanationText
```
 final Unit setEnableCameraExplanationText(String enableCameraExplanationText)
```
    Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
  - getFinderLineColor
```
 final JsonColor getFinderLineColor()
```
    Foreground color of the detection overlay.
  - setFinderLineColor
```
 final Unit setFinderLineColor(JsonColor finderLineColor)
```
    Foreground color of the detection overlay.
  - getFinderLineWidth
```
 final Double getFinderLineWidth()
```
    Width of finder frame border. Default is 2.
  - setFinderLineWidth
```
 final Unit setFinderLineWidth(Double finderLineWidth)
```
    Width of finder frame border. Default is 2.
  - getFinderTextHint
```
 final String getFinderTextHint()
```
    String being displayed as description.
  - setFinderTextHint
```
 final Unit setFinderTextHint(String finderTextHint)
```
    String being displayed as description.
  - getFinderTextHintColor
```
 final JsonColor getFinderTextHintColor()
```
    Foreground color of the description label.
  - setFinderTextHintColor
```
 final Unit setFinderTextHintColor(JsonColor finderTextHintColor)
```
    Foreground color of the description label.
  - getFinderAspectRatio
```
 final JsonAspectRatio getFinderAspectRatio()
```
    Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
  - setFinderAspectRatio
```
 final Unit setFinderAspectRatio(JsonAspectRatio finderAspectRatio)
```
    Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
  - getFlashButtonInactiveColor
```
 final JsonColor getFlashButtonInactiveColor()
```
    Foreground color of the flash button when flash is off.
  - setFlashButtonInactiveColor
```
 final Unit setFlashButtonInactiveColor(JsonColor flashButtonInactiveColor)
```
    Foreground color of the flash button when flash is off.
  - getFlashEnabled
```
 final Boolean getFlashEnabled()
```
    Whether flash is toggled on or off.
  - setFlashEnabled
```
 final Unit setFlashEnabled(Boolean flashEnabled)
```
    Whether flash is toggled on or off.
  - getTouchToFocusEnabled
```
 final Boolean getTouchToFocusEnabled()
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  - setTouchToFocusEnabled
```
 final Unit setTouchToFocusEnabled(Boolean touchToFocusEnabled)
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  - getOrientationLockMode
```
 final JsonOrientationLockMode getOrientationLockMode()
```
    UI Interface orientation lock mode
  - setOrientationLockMode
```
 final Unit setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
```
    UI Interface orientation lock mode
  - getMinimumTextLength
```
 final Integer getMinimumTextLength()
```
    Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - setMinimumTextLength
```
 final Unit setMinimumTextLength(Integer minimumTextLength)
```
    Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - getMaximumTextLength
```
 final Integer getMaximumTextLength()
```
    Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - setMaximumTextLength
```
 final Unit setMaximumTextLength(Integer maximumTextLength)
```
    Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - getMinFocusDistanceLock
```
 final Boolean getMinFocusDistanceLock()
```
    Lock focus distance withing minimum possible range
  - setMinFocusDistanceLock
```
 final Unit setMinFocusDistanceLock(Boolean minFocusDistanceLock)
```
    Lock focus distance withing minimum possible range
  - getMinimum1DBarcodesQuietZone
```
 final Integer getMinimum1DBarcodesQuietZone()
```
    Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
  - setMinimum1DBarcodesQuietZone
```
 final Unit setMinimum1DBarcodesQuietZone(Integer minimum1DBarcodesQuietZone)
```
    Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
  - getStripCheckDigits
```
 final Boolean getStripCheckDigits()
```
    With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
  - setStripCheckDigits
```
 final Unit setStripCheckDigits(Boolean stripCheckDigits)
```
    With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
  - getUseIATA2OF5Checksum
```
 final Boolean getUseIATA2OF5Checksum()
```
    If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.
  - setUseIATA2OF5Checksum
```
 final Unit setUseIATA2OF5Checksum(Boolean useIATA2OF5Checksum)
```
    If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.
  - getUseCode11Checksum
```
 final Boolean getUseCode11Checksum()
```
    If true, the optional check digit for CODE_11 codes is used in validation. The default is true.
  - setUseCode11Checksum
```
 final Unit setUseCode11Checksum(Boolean useCode11Checksum)
```
    If true, the optional check digit for CODE_11 codes is used in validation. The default is true.
  - getSuccessBeepEnabled
```
 final Boolean getSuccessBeepEnabled()
```
    Whether scanner screen should make a sound on successful barcode or MRZ detection.
  - setSuccessBeepEnabled
```
 final Unit setSuccessBeepEnabled(Boolean successBeepEnabled)
```
    Whether scanner screen should make a sound on successful barcode or MRZ detection.
  - getTopBarBackgroundColor
```
 final JsonColor getTopBarBackgroundColor()
```
    Background color of the top bar.
  - setTopBarBackgroundColor
```
 final Unit setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
```
    Background color of the top bar.
  - getTopBarButtonsColor
```
 final JsonColor getTopBarButtonsColor()
```
    Foreground color of the cancel button.
  - setTopBarButtonsColor
```
 final Unit setTopBarButtonsColor(JsonColor topBarButtonsColor)
```
    Foreground color of the cancel button.
  - getBarcodeFormats
```
 final List<JsonBarcodeFormat> getBarcodeFormats()
```
    Accepted barcode formats
  - setBarcodeFormats
```
 final Unit setBarcodeFormats(List<JsonBarcodeFormat> barcodeFormats)
```
    Accepted barcode formats
  - getUseButtonsAllCaps
```
 final Boolean getUseButtonsAllCaps()
```
    Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - setUseButtonsAllCaps
```
 final Unit setUseButtonsAllCaps(Boolean useButtonsAllCaps)
```
    Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - getReplaceCancelButtonWithIcon
```
 final Boolean getReplaceCancelButtonWithIcon()
```
    If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
  - setReplaceCancelButtonWithIcon
```
 final Unit setReplaceCancelButtonWithIcon(Boolean replaceCancelButtonWithIcon)
```
    If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
  - getCameraPreviewMode
```
 final JsonCameraPreviewMode getCameraPreviewMode()
```
    Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  - setCameraPreviewMode
```
 final Unit setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)
```
    Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  - getCameraZoomRange
```
 final JsonZoomRange getCameraZoomRange()
```
    The range of valid camera zoom factors. Default value is (1.0; 12.0).
  - setCameraZoomRange
```
 final Unit setCameraZoomRange(JsonZoomRange cameraZoomRange)
```
    The range of valid camera zoom factors. Default value is (1.0; 12.0).
  - getAutoCancelTimeout
```
 final Integer getAutoCancelTimeout()
```
    Sets auto close timer in seconds. 0 = disabled and it is the default value.
  - setAutoCancelTimeout
```
 final Unit setAutoCancelTimeout(Integer autoCancelTimeout)
```
    Sets auto close timer in seconds. 0 = disabled and it is the default value.
  - getGs1HandlingMode
```
 final JsonGs1HandlingMode getGs1HandlingMode()
```
    The GS1 handling mode. The default value is PARSE.
  - setGs1HandlingMode
```
 final Unit setGs1HandlingMode(JsonGs1HandlingMode gs1HandlingMode)
```
    The GS1 handling mode. The default value is PARSE.
  - getMsiPlesseyChecksumAlgorithm
```
 final JsonMSIPlesseyChecksumAlgorithm getMsiPlesseyChecksumAlgorithm()
```
    The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
  - setMsiPlesseyChecksumAlgorithm
```
 final Unit setMsiPlesseyChecksumAlgorithm(JsonMSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm)
```
    The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
  - getAustraliaPostCustomerFormat
```
 final JsonAustraliaPostCustomerFormat getAustraliaPostCustomerFormat()
```
    The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62.
  - setAustraliaPostCustomerFormat
```
 final Unit setAustraliaPostCustomerFormat(JsonAustraliaPostCustomerFormat australiaPostCustomerFormat)
```
    The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62.
  - getLowPowerMode
```
 final Boolean getLowPowerMode()
```
    If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
  - setLowPowerMode
```
 final Unit setLowPowerMode(Boolean lowPowerMode)
```
    If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
  - getBarcodeImageGenerationType
```
 final JsonBarcodeImageGenerationType getBarcodeImageGenerationType()
```
    The type of barcode image generation.
  - setBarcodeImageGenerationType
```
 final Unit setBarcodeImageGenerationType(JsonBarcodeImageGenerationType barcodeImageGenerationType)
```
    The type of barcode image generation.
  - getInitialScanDelay
```
 final Double getInitialScanDelay()
```
    Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
  - setInitialScanDelay
```
 final Unit setInitialScanDelay(Double initialScanDelay)
```
    Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
  - getDelayAfterScan
```
 final Double getDelayAfterScan()
```
    Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
  - setDelayAfterScan
```
 final Unit setDelayAfterScan(Double delayAfterScan)
```
    Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
  - getViewFinderEnabled
```
 final Boolean getViewFinderEnabled()
```
    Display the region of interest. The default value is TRUE.
  - setViewFinderEnabled
```
 final Unit setViewFinderEnabled(Boolean viewFinderEnabled)
```
    Display the region of interest. The default value is TRUE.
  - getConfirmationDialogConfiguration
```
 final JsonConfirmationDialogConfiguration getConfirmationDialogConfiguration()
```
    The confirmation dialog configuration.
  - setConfirmationDialogConfiguration
```
 final Unit setConfirmationDialogConfiguration(JsonConfirmationDialogConfiguration confirmationDialogConfiguration)
```
    The confirmation dialog configuration.
  - getOverlayConfiguration
```
 final JsonSelectionOverlayConfiguration getOverlayConfiguration()
```
    The selection overlay configuration.
  - setOverlayConfiguration
```
 final Unit setOverlayConfiguration(JsonSelectionOverlayConfiguration overlayConfiguration)
```
    The selection overlay configuration.

Class BarcodeScannerJsonConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeScannerJsonConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getAcceptedDocumentFormats

setAcceptedDocumentFormats

getBarcodesExtensionFilter

setBarcodesExtensionFilter

getCameraOverlayColor

setCameraOverlayColor

getCameraModule

setCameraModule

getCameraZoomFactor

setCameraZoomFactor

getCancelButtonTitle

setCancelButtonTitle

getEngineMode

setEngineMode

getEnableCameraButtonTitle

setEnableCameraButtonTitle

getEnableCameraExplanationText

setEnableCameraExplanationText

getFinderLineColor

setFinderLineColor

getFinderLineWidth

setFinderLineWidth

getFinderTextHint

setFinderTextHint

getFinderTextHintColor

setFinderTextHintColor

getFinderAspectRatio

setFinderAspectRatio

getFlashButtonInactiveColor

setFlashButtonInactiveColor

getFlashEnabled

setFlashEnabled

getTouchToFocusEnabled

setTouchToFocusEnabled

getOrientationLockMode

setOrientationLockMode

getMinimumTextLength

setMinimumTextLength

getMaximumTextLength

setMaximumTextLength

getMinFocusDistanceLock

setMinFocusDistanceLock

getMinimum1DBarcodesQuietZone

setMinimum1DBarcodesQuietZone

getStripCheckDigits

setStripCheckDigits

getUseIATA2OF5Checksum

setUseIATA2OF5Checksum

getUseCode11Checksum

setUseCode11Checksum

getSuccessBeepEnabled

setSuccessBeepEnabled

getTopBarBackgroundColor

setTopBarBackgroundColor

getTopBarButtonsColor

setTopBarButtonsColor

getBarcodeFormats

setBarcodeFormats

getUseButtonsAllCaps

setUseButtonsAllCaps

getReplaceCancelButtonWithIcon

setReplaceCancelButtonWithIcon

getCameraPreviewMode

setCameraPreviewMode

getCameraZoomRange

setCameraZoomRange