ArOverlayGeneralConfiguration

data class ArOverlayGeneralConfiguration(var visible: Boolean = false, var counterBadge: BadgeStyle = BadgeStyle( background = BackgroundStyle( ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var automaticSelectionEnabled: Boolean = false, var barcodeItemInfoPosition: BarcodeItemInfoPosition = BarcodeItemInfoPosition.BELOW, var polygon: ArOverlayPolygonConfiguration = ArOverlayPolygonConfiguration( visible = true, deselected = PolygonStyle( ), selected = PolygonStyle( ) ), var barcodeItemConfiguration: BarcodeItemConfiguration = BarcodeItemConfiguration( imageVisible = true, titleSelected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleSelected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), titleDeselected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleDeselected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), backgroundSelected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ), backgroundDeselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ) ))

Configuration of the AR overlay displayed on top of barcodes in the camera preview.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JsonObject)
constructor(visible: Boolean = false, counterBadge: BadgeStyle = BadgeStyle( background = BackgroundStyle( ), foregroundColor = ScanbotColor("?sbColorOnSurface", isArgb = false) ), automaticSelectionEnabled: Boolean = false, barcodeItemInfoPosition: BarcodeItemInfoPosition = BarcodeItemInfoPosition.BELOW, polygon: ArOverlayPolygonConfiguration = ArOverlayPolygonConfiguration( visible = true, deselected = PolygonStyle( ), selected = PolygonStyle( ) ), barcodeItemConfiguration: BarcodeItemConfiguration = BarcodeItemConfiguration( imageVisible = true, titleSelected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleSelected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), titleDeselected = StyledText( text = "BARCODE_TITLE", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitleDeselected = StyledText( text = "BARCODE_SUBTITLE", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), backgroundSelected = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("?sbColorPositive", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ), backgroundDeselected = PolygonStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 1.0, cornerRadius = 5.0 ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

Configuration of the barcode info box displayed in the camera preview.

Link copied to clipboard

Where to display the barcode info box in the camera preview. Default is BELOW

Link copied to clipboard

Parameters of the counter badge appearance e.g. color of background its stroke and text/icon color.

Link copied to clipboard

Configuration of the overlay polygon displayed on top of a barcode in the camera preview.

Link copied to clipboard

Control the visibility of the user guidance. Default is false

Functions

Link copied to clipboard
fun toJson(): JsonObject