scanbot-sdk-compose-multiplatform/io.scanbot.sdk.compose.multiplatform.configuration/BarcodeScannerConfiguration

BarcodeScannerConfiguration

data class BarcodeScannerConfiguration(val version: String = "1.0", val screen: String = "BarcodeScanner", var palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), var localization: BarcodeTextLocalization = BarcodeTextLocalization( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), var topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( text = "?topBarTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), mode = TopBarMode.SOLID, statusBarMode = StatusBarMode.LIGHT, backgroundColor = ScanbotColor("?sbColorPrimary", isArgb = false), cancelButton = ButtonConfiguration( visible = true, text = "?topBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ) ), var actionBar: ActionBarConfiguration = ActionBarConfiguration( flashButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ), zoomButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), flipCameraButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var viewFinder: ViewFinderConfiguration = ViewFinderConfiguration( visible = true, style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), overlayColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), aspectRatio = AspectRatio( width = 1.0, height = 1.0 ) ), var userGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( visible = true, title = StyledText( text = "?userGuidance", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), strokeWidth = 0.0 ) ), var cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), var cameraConfiguration: CameraConfiguration = CameraConfiguration( ), var recognizerConfiguration: BarcodeRecognizerConfiguration = BarcodeRecognizerConfiguration( ), var useCase: BarcodeUseCase = SingleScanningMode( ), var sound: Sound = Sound( successBeepEnabled = true, soundType = SoundType.MODERN_BEEP ), var vibration: Vibration = Vibration( enabled = true ), var timeouts: Timeouts = Timeouts( autoCancelTimeout = 0, initialScanDelay = 0 ))

Configuration of the barcode scanner screen.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JsonObject)
constructor(version: String = "1.0", screen: String = "BarcodeScanner", palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), localization: BarcodeTextLocalization = BarcodeTextLocalization( ), backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), topBar: TopBarConfiguration = TopBarConfiguration( title = StyledText( text = "?topBarTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), mode = TopBarMode.SOLID, statusBarMode = StatusBarMode.LIGHT, backgroundColor = ScanbotColor("?sbColorPrimary", isArgb = false), cancelButton = ButtonConfiguration( visible = true, text = "?topBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ) ), actionBar: ActionBarConfiguration = ActionBarConfiguration( flashButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorWarning", isArgb = false), activeForegroundColor = ScanbotColor("#1C1B1F", isArgb = false) ), zoomButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), flipCameraButton = RoundButton( visible = true, backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), activeBackgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), activeForegroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), viewFinder: ViewFinderConfiguration = ViewFinderConfiguration( visible = true, style = FinderCorneredStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 2.0, cornerRadius = 10.0 ), overlayColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), aspectRatio = AspectRatio( width = 1.0, height = 1.0 ) ), userGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( visible = true, title = StyledText( text = "?userGuidance", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), strokeWidth = 0.0 ) ), cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), cameraConfiguration: CameraConfiguration = CameraConfiguration( ), recognizerConfiguration: BarcodeRecognizerConfiguration = BarcodeRecognizerConfiguration( ), useCase: BarcodeUseCase = SingleScanningMode( ), sound: Sound = Sound( successBeepEnabled = true, soundType = SoundType.MODERN_BEEP ), vibration: Vibration = Vibration( enabled = true ), timeouts: Timeouts = Timeouts( autoCancelTimeout = 0, initialScanDelay = 0 ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var actionBar: ActionBarConfiguration

Configuration of the action bar.

Link copied to clipboard
var backgroundColor: ScanbotColor

Color of the screen's background. Default is "?sbColorSurfaceLow"

Link copied to clipboard
var cameraConfiguration: CameraConfiguration

Configuration of the camera behavior.

Link copied to clipboard
var cameraPermission: CameraPermissionScreen

Configuration of the dialog for requesting camera permissions.

Link copied to clipboard
var localization: BarcodeTextLocalization

Configuration of the all strings for barcode scanner.

Link copied to clipboard
var palette: Palette

Define the screen's base color values from which other colors are derived.

Link copied to clipboard
var recognizerConfiguration: BarcodeRecognizerConfiguration

Configuration of the scanning behavior.

Link copied to clipboard
val screen: String

The configuration object should be applied for this screen. Default is "BarcodeScanner"

Link copied to clipboard
var sound: Sound

Configuration of the scan confirmation sound.

Link copied to clipboard
var timeouts: Timeouts

Configuration of timeouts.

Link copied to clipboard
var topBar: TopBarConfiguration

Configuration of the top bar.

Link copied to clipboard
var useCase: BarcodeUseCase

Configuration of the barcode scanner screen's behavior.

Link copied to clipboard
var userGuidance: UserGuidanceConfiguration

Configuration of the text hint guiding users to move the view finder over a barcode.

Link copied to clipboard
val version: String

Version number of the configuration object. Default is "1.0"

Link copied to clipboard
var vibration: Vibration

Configuration of the scan scan confirmation vibration.

Link copied to clipboard
var viewFinder: ViewFinderConfiguration

Configuration of the view finder.

Functions

Link copied to clipboard
fun toJson(): JsonObject