All Implemented Interfaces:

android.os.Parcelable
```
public final class ArOverlayGeneralConfiguration
 implements Parcelable
                    
```
Configuration of the AR overlay displayed on top of barcodes in the camera preview.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`visible`
`private BadgeStyle`	`counterBadge`
`private Boolean`	`automaticSelectionEnabled`
`private BarcodeItemInfoPosition`	`barcodeItemInfoPosition`
`private ArOverlayPolygonConfiguration`	`polygon`
`private BarcodeItemConfiguration`	`barcodeItemConfiguration`

Constructor Summary

Constructors
Constructor	Description
`ArOverlayGeneralConfiguration(Map<String, Object> source)`
`ArOverlayGeneralConfiguration(JSONObject json)`
`ArOverlayGeneralConfiguration(Boolean visible, BadgeStyle counterBadge, Boolean automaticSelectionEnabled, BarcodeItemInfoPosition barcodeItemInfoPosition, ArOverlayPolygonConfiguration polygon, BarcodeItemConfiguration barcodeItemConfiguration)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getVisible()`	Control the visibility of the user guidance.
`final Unit`	`setVisible(Boolean visible)`	Control the visibility of the user guidance.
`final BadgeStyle`	`getCounterBadge()`	Parameters of the counter badge appearance e.g.
`final Unit`	`setCounterBadge(BadgeStyle counterBadge)`	Parameters of the counter badge appearance e.g.
`final Boolean`	`getAutomaticSelectionEnabled()`	If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view.
`final Unit`	`setAutomaticSelectionEnabled(Boolean automaticSelectionEnabled)`	If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view.
`final BarcodeItemInfoPosition`	`getBarcodeItemInfoPosition()`	Where to display the barcode info box in the camera preview.
`final Unit`	`setBarcodeItemInfoPosition(BarcodeItemInfoPosition barcodeItemInfoPosition)`	Where to display the barcode info box in the camera preview.
`final ArOverlayPolygonConfiguration`	`getPolygon()`	Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
`final Unit`	`setPolygon(ArOverlayPolygonConfiguration polygon)`	Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
`final BarcodeItemConfiguration`	`getBarcodeItemConfiguration()`	Configuration of the barcode info box displayed in the camera preview.
`final Unit`	`setBarcodeItemConfiguration(BarcodeItemConfiguration barcodeItemConfiguration)`	Configuration of the barcode info box displayed in the camera preview.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final ArOverlayGeneralConfiguration`	`clone()`
`final static ArOverlayGeneralConfiguration`	`default()`

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

- Constructor Detail
  - ArOverlayGeneralConfiguration
```
ArOverlayGeneralConfiguration(Map<String, Object> source)
```
  - ArOverlayGeneralConfiguration
```
ArOverlayGeneralConfiguration(JSONObject json)
```
  - ArOverlayGeneralConfiguration
```
ArOverlayGeneralConfiguration(Boolean visible, BadgeStyle counterBadge, Boolean automaticSelectionEnabled, BarcodeItemInfoPosition barcodeItemInfoPosition, ArOverlayPolygonConfiguration polygon, BarcodeItemConfiguration barcodeItemConfiguration)
```
- Method Detail
  - getVisible
```
 final Boolean getVisible()
```
    Control the visibility of the user guidance.
    Default is false
  - setVisible
```
 final Unit setVisible(Boolean visible)
```
    Control the visibility of the user guidance.
    Default is false
  - getCounterBadge
```
 final BadgeStyle getCounterBadge()
```
    Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color.
  - setCounterBadge
```
 final Unit setCounterBadge(BadgeStyle counterBadge)
```
    Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color.
  - getAutomaticSelectionEnabled
```
 final Boolean getAutomaticSelectionEnabled()
```
    If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them.
    Default is false
  - setAutomaticSelectionEnabled
```
 final Unit setAutomaticSelectionEnabled(Boolean automaticSelectionEnabled)
```
    If enabled, the scanner will always immediately scan a barcode in the viewfinder or the camera view. The overlay will mark the scanned barcodes and stays above them.
    Default is false
  - getBarcodeItemInfoPosition
```
 final BarcodeItemInfoPosition getBarcodeItemInfoPosition()
```
    Where to display the barcode info box in the camera preview.
    Default is BELOW
  - setBarcodeItemInfoPosition
```
 final Unit setBarcodeItemInfoPosition(BarcodeItemInfoPosition barcodeItemInfoPosition)
```
    Where to display the barcode info box in the camera preview.
    Default is BELOW
  - getPolygon
```
 final ArOverlayPolygonConfiguration getPolygon()
```
    Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
  - setPolygon
```
 final Unit setPolygon(ArOverlayPolygonConfiguration polygon)
```
    Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
  - getBarcodeItemConfiguration
```
 final BarcodeItemConfiguration getBarcodeItemConfiguration()
```
    Configuration of the barcode info box displayed in the camera preview.
  - setBarcodeItemConfiguration
```
 final Unit setBarcodeItemConfiguration(BarcodeItemConfiguration barcodeItemConfiguration)
```
    Configuration of the barcode info box displayed in the camera preview.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final ArOverlayGeneralConfiguration clone()
```
  - default
```
 final static ArOverlayGeneralConfiguration default()
```

Class ArOverlayGeneralConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArOverlayGeneralConfiguration

ArOverlayGeneralConfiguration

ArOverlayGeneralConfiguration

Method Detail

getVisible

setVisible

getCounterBadge

setCounterBadge

getAutomaticSelectionEnabled

setAutomaticSelectionEnabled

getBarcodeItemInfoPosition

setBarcodeItemInfoPosition

getPolygon

setPolygon

getBarcodeItemConfiguration

setBarcodeItemConfiguration

toJson

clone

default