Class LicensePlateScannerConfiguration
-
- All Implemented Interfaces:
public final class LicensePlateScannerConfiguration
Class which is used to configure io.scanbot.sdk.ui.view.licenseplate.LicensePlateScannerActivity Contains settings indicating views Behaviour, Texts and Appearance
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
LicensePlateScannerConfiguration.Companion
-
Field Summary
Fields Modifier and Type Field Description private final LicensePlateScannerJsonConfiguration
params
private final LicensePlateScannerNativeConfiguration
nativeParams
public final static LicensePlateScannerConfiguration.Companion
Companion
-
Constructor Summary
Constructors Constructor Description LicensePlateScannerConfiguration()
LicensePlateScannerConfiguration(LicensePlateScannerJsonConfiguration params, LicensePlateScannerNativeConfiguration nativeParams)
-
Method Summary
Modifier and Type Method Description final LicensePlateScannerJsonConfiguration
getParams()
final LicensePlateScannerNativeConfiguration
getNativeParams()
final Unit
setFlashEnabled(Boolean flashEnabled)
Controls whether the flash should be initially enabled. final Unit
setOrientationLockMode(CameraOrientationMode cameraOrientationMode)
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. final Unit
setCameraModule(CameraModule cameraModule)
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. final Unit
setCameraPreviewMode(CameraPreviewMode cameraPreviewMode)
Preview mode of the camera: Fit-In or Fill-In. final Unit
setTopBarBackgroundColor(Integer topBarBackgroundColor)
Background color of the top toolbar. final Unit
setTopBarButtonsColor(Integer topBarButtonsColor)
Color of the titles of all buttons in the top toolbar. final Unit
setTopBarButtonsInactiveColor(Integer topBarButtonsInactiveColor)
Color of the titles of all buttons in the top toolbar. final Unit
setCameraOverlayColor(Integer cameraOverlayColor)
Background color outside of the finder window. final Unit
setFinderLineWidth(Integer finderLineWidth)
Thickness of the finder window's outline in Px. final Unit
setFinderLineColor(Integer finderLineColor)
Color of the finder window's outline. final Unit
setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button. final Unit
setCancelButtonIcon(Integer cancelButtonIcon)
Icon of the cancel button. final Unit
setConfirmationDialogTitle(String title)
Confirmation dialog title final Unit
setConfirmationDialogMessage(String message)
Confirmation dialog message final Unit
setConfirmationDialogConfirmButtonTitle(String confirmButton)
Confirmation dialog confirm button text final Unit
setConfirmationDialogRetryButtonTitle(String retryButton)
Confirmation dialog retry button text final Unit
setConfirmationDialogAccentColor(Integer dialogAccentColor)
The accent color of buttons on a confirmation dialog final Unit
setConfirmationDialogConfirmButtonFilled(Boolean buttonFilled)
Allows to set if the confirm button should be filled final Unit
setConfirmationDialogConfirmButtonFilledTextColor(Integer textColor)
Allows to set a text color of the filled button. 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 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 Unit
setMinNumberOfRequiredFramesWithEqualRecognitionResult(Integer numberOfFrames)
Minimum number of accumulated frames that have equal result final Unit
setMaximumNumberOfAccumulatedFrames(Integer numberOfFrames)
Maximum number of accumulated frames to inspect before actual result is returned final Unit
setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style final Unit
setFinderTextHint(String finderTextHint)
User guidance text below the finder view final Unit
setFinderTextHintColor(Integer finderTextHintColor)
The color of the text with user guidance below the finder view final Unit
setScanStrategy(LicensePlateScanStrategy scanStrategy)
Additional parameter to set the type of the scanned object. final Unit
setSignificantShakeDelay(Long significantShakeDelay)
Detection will be paused after significant movement Default is 1000 final Unit
setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. -
-
Constructor Detail
-
LicensePlateScannerConfiguration
LicensePlateScannerConfiguration()
-
LicensePlateScannerConfiguration
LicensePlateScannerConfiguration(LicensePlateScannerJsonConfiguration params, LicensePlateScannerNativeConfiguration nativeParams)
-
-
Method Detail
-
getParams
final LicensePlateScannerJsonConfiguration getParams()
-
getNativeParams
final LicensePlateScannerNativeConfiguration getNativeParams()
-
setFlashEnabled
final Unit setFlashEnabled(Boolean flashEnabled)
Controls whether the flash should be initially enabled. The default value is FALSE.
-
setOrientationLockMode
final Unit setOrientationLockMode(CameraOrientationMode cameraOrientationMode)
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.
-
setCameraModule
final Unit setCameraModule(CameraModule cameraModule)
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
-
setCameraPreviewMode
final Unit setCameraPreviewMode(CameraPreviewMode cameraPreviewMode)
Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fill-In.
-
setTopBarBackgroundColor
final Unit setTopBarBackgroundColor(Integer topBarBackgroundColor)
Background color of the top toolbar.
-
setTopBarButtonsColor
final Unit setTopBarButtonsColor(Integer topBarButtonsColor)
Color of the titles of all buttons in the top toolbar.
-
setTopBarButtonsInactiveColor
final Unit setTopBarButtonsInactiveColor(Integer topBarButtonsInactiveColor)
Color of the titles of all buttons in the top toolbar.
-
setCameraOverlayColor
final Unit setCameraOverlayColor(Integer cameraOverlayColor)
Background color outside of the finder window.
-
setFinderLineWidth
final Unit setFinderLineWidth(Integer finderLineWidth)
Thickness of the finder window's outline in Px.
-
setFinderLineColor
final Unit setFinderLineColor(Integer finderLineColor)
Color of the finder window's outline.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button.
-
setCancelButtonIcon
final Unit setCancelButtonIcon(Integer cancelButtonIcon)
Icon of the cancel button.
-
setConfirmationDialogTitle
final Unit setConfirmationDialogTitle(String title)
Confirmation dialog title
-
setConfirmationDialogMessage
final Unit setConfirmationDialogMessage(String message)
Confirmation dialog message
-
setConfirmationDialogConfirmButtonTitle
final Unit setConfirmationDialogConfirmButtonTitle(String confirmButton)
Confirmation dialog confirm button text
-
setConfirmationDialogRetryButtonTitle
final Unit setConfirmationDialogRetryButtonTitle(String retryButton)
Confirmation dialog retry button text
-
setConfirmationDialogAccentColor
final Unit setConfirmationDialogAccentColor(Integer dialogAccentColor)
The accent color of buttons on a confirmation dialog
-
setConfirmationDialogConfirmButtonFilled
final Unit setConfirmationDialogConfirmButtonFilled(Boolean buttonFilled)
Allows to set if the confirm button should be filled
-
setConfirmationDialogConfirmButtonFilledTextColor
final Unit setConfirmationDialogConfirmButtonFilledTextColor(Integer textColor)
Allows to set a text color of the filled button. See setConfirmationDialogConfirmButtonFilled
-
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.
-
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.
-
setMinNumberOfRequiredFramesWithEqualRecognitionResult
final Unit setMinNumberOfRequiredFramesWithEqualRecognitionResult(Integer numberOfFrames)
Minimum number of accumulated frames that have equal result
-
setMaximumNumberOfAccumulatedFrames
final Unit setMaximumNumberOfAccumulatedFrames(Integer numberOfFrames)
Maximum number of accumulated frames to inspect before actual result is returned
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style
-
setFinderTextHint
final Unit setFinderTextHint(String finderTextHint)
User guidance text below the finder view
-
setFinderTextHintColor
final Unit setFinderTextHintColor(Integer finderTextHintColor)
The color of the text with user guidance below the finder view
-
setScanStrategy
final Unit setScanStrategy(LicensePlateScanStrategy scanStrategy)
Additional parameter to set the type of the scanned object. @see LicensePlateScanStrategy. Default is LicensePlateScanStrategy.LicensePlateML
-
setSignificantShakeDelay
final Unit setSignificantShakeDelay(Long significantShakeDelay)
Detection will be paused after significant movement Default is 1000
-
setTouchToFocusEnabled
final Unit setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. Default is
true
.
-
-
-
-