Class ArOverlayGeneralConfiguration
-
- 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.
-
-
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> json)
ArOverlayGeneralConfiguration()
ArOverlayGeneralConfiguration(Boolean visible, BadgeStyle counterBadge, Boolean automaticSelectionEnabled, BarcodeItemInfoPosition barcodeItemInfoPosition, ArOverlayPolygonConfiguration polygon, BarcodeItemConfiguration barcodeItemConfiguration)
-
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. -
-
Constructor Detail
-
ArOverlayGeneralConfiguration
ArOverlayGeneralConfiguration()
-
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.
-
setVisible
final Unit setVisible(Boolean visible)
Control the visibility of the user guidance.
-
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.
-
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.
-
getBarcodeItemInfoPosition
final BarcodeItemInfoPosition getBarcodeItemInfoPosition()
Where to display the barcode info box in the camera preview.
-
setBarcodeItemInfoPosition
final Unit setBarcodeItemInfoPosition(BarcodeItemInfoPosition barcodeItemInfoPosition)
Where to display the barcode info box in the camera preview.
-
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.
-
-
-
-