Class LicensePlateScannerJsonConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class LicensePlateScannerJsonConfiguration implements Parcelable
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description LicensePlateScannerJsonConfiguration(String version, String screen, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, String finderTextHint, JsonColor finderTextHintColor, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, Integer minNumberOfRequiredFramesWithEqualRecognitionResult, Integer maximumNumberOfAccumulatedFrames, Boolean useButtonsAllCaps, Long significantShakeDelay, JsonLicensePlateScanStrategy scanStrategy, String confirmationDialogTitle, String confirmationDialogMessage, String confirmationDialogConfirmButtonTitle, String confirmationDialogRetryButtonTitle, JsonColor confirmationDialogAccentColor, Boolean confirmationDialogConfirmButtonFilled, JsonColor confirmationDialogConfirmButtonFilledTextColor, Boolean replaceCancelButtonWithIcon, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled)
-
Method Summary
Modifier and Type Method Description final String
getVersion()
A version of the configuration object final Unit
setVersion(String version)
A version of the configuration object final String
getScreen()
The configuration object should be applied for this screen final Unit
setScreen(String screen)
The configuration object should be applied for this screen final JsonCameraModule
getCameraModule()
The preferred camera module (default - BACK) final Unit
setCameraModule(JsonCameraModule cameraModule)
The preferred camera module (default - BACK) final JsonColor
getCameraOverlayColor()
Background color outside of the finder window. final Unit
setCameraOverlayColor(JsonColor cameraOverlayColor)
Background color outside of the finder window. final String
getCancelButtonTitle()
Title of the cancel button. final Unit
setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button. final String
getEnableCameraButtonTitle()
Title of the button that opens the screen where the user can allow the usage of the camera by the app. 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 String
getEnableCameraExplanationText()
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
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 JsonColor
getFinderLineColor()
Foreground color of the detection overlay. final Unit
setFinderLineColor(JsonColor finderLineColor)
Foreground color of the detection overlay. final Double
getFinderLineWidth()
Width of finder frame border. final Unit
setFinderLineWidth(Double finderLineWidth)
Width of finder frame border. final String
getFinderTextHint()
User guidance text below the finder view final Unit
setFinderTextHint(String finderTextHint)
User guidance text below the finder view final JsonColor
getFinderTextHintColor()
Foreground color of the description label. final Unit
setFinderTextHintColor(JsonColor finderTextHintColor)
Foreground color of the description label. final Boolean
getFlashEnabled()
Controls whether the flash should be initially enabled. final Unit
setFlashEnabled(Boolean flashEnabled)
Controls whether the flash should be initially enabled. final JsonOrientationLockMode
getOrientationLockMode()
UI Interface orientation lock mode final Unit
setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
UI Interface orientation lock mode final JsonColor
getTopBarBackgroundColor()
The background color of the top toolbar. final Unit
setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
The background color of the top toolbar. final JsonColor
getTopBarButtonsActiveColor()
The color of all active toggle buttons in the toolbar. final Unit
setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)
The color of all active toggle buttons in the toolbar. final JsonColor
getTopBarButtonsInactiveColor()
The color of all inactive toggle buttons in the toolbar. final Unit
setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)
The color of all inactive toggle buttons in the toolbar. final Integer
getMinNumberOfRequiredFramesWithEqualRecognitionResult()
Minimum number of accumulated frames that have equal result final Unit
setMinNumberOfRequiredFramesWithEqualRecognitionResult(Integer minNumberOfRequiredFramesWithEqualRecognitionResult)
Minimum number of accumulated frames that have equal result final Integer
getMaximumNumberOfAccumulatedFrames()
Maximum number of accumulated frames to inspect before actual result is returned final Unit
setMaximumNumberOfAccumulatedFrames(Integer maximumNumberOfAccumulatedFrames)
Maximum number of accumulated frames to inspect before actual result is returned final Boolean
getUseButtonsAllCaps()
Controls whether buttons should use all capitals style, as defined by the Android Material Design. final Unit
setUseButtonsAllCaps(Boolean useButtonsAllCaps)
Controls whether buttons should use all capitals style, as defined by the Android Material Design. final Long
getSignificantShakeDelay()
Threshold used to pause the detection after significant movement occurred. final Unit
setSignificantShakeDelay(Long significantShakeDelay)
Threshold used to pause the detection after significant movement occurred. final JsonLicensePlateScanStrategy
getScanStrategy()
Detector mode, classic (OCR based) or ML (machine learning based) approach. final Unit
setScanStrategy(JsonLicensePlateScanStrategy scanStrategy)
Detector mode, classic (OCR based) or ML (machine learning based) approach. final String
getConfirmationDialogTitle()
The title of the confirmation dialog. final Unit
setConfirmationDialogTitle(String confirmationDialogTitle)
The title of the confirmation dialog. final String
getConfirmationDialogMessage()
The message text of the confirmation dialog. final Unit
setConfirmationDialogMessage(String confirmationDialogMessage)
The message text of the confirmation dialog. final String
getConfirmationDialogConfirmButtonTitle()
The title of the confirmation dialog retry button. final Unit
setConfirmationDialogConfirmButtonTitle(String confirmationDialogConfirmButtonTitle)
The title of the confirmation dialog retry button. final String
getConfirmationDialogRetryButtonTitle()
The title of the confirmation dialog confirm button. final Unit
setConfirmationDialogRetryButtonTitle(String confirmationDialogRetryButtonTitle)
The title of the confirmation dialog confirm button. final JsonColor
getConfirmationDialogAccentColor()
The accent color of buttons on a confirmation dialog. final Unit
setConfirmationDialogAccentColor(JsonColor confirmationDialogAccentColor)
The accent color of buttons on a confirmation dialog. final Boolean
getConfirmationDialogConfirmButtonFilled()
Allows to set if the confirm button should be filled. final Unit
setConfirmationDialogConfirmButtonFilled(Boolean confirmationDialogConfirmButtonFilled)
Allows to set if the confirm button should be filled. final JsonColor
getConfirmationDialogConfirmButtonFilledTextColor()
Allows to set a text color of the filled button. final Unit
setConfirmationDialogConfirmButtonFilledTextColor(JsonColor confirmationDialogConfirmButtonFilledTextColor)
Allows to set a text color of the filled button. final Boolean
getReplaceCancelButtonWithIcon()
If true
, replaces the cancel button in the top bar with a back arrow icon.final Unit
setReplaceCancelButtonWithIcon(Boolean replaceCancelButtonWithIcon)
If true
, replaces the cancel button in the top bar with a back arrow icon.final JsonCameraPreviewMode
getCameraPreviewMode()
Preview mode of the camera. final Unit
setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)
Preview mode of the camera. final Boolean
getTouchToFocusEnabled()
Whether touch-to-focus is enabled on camera preview. final Unit
setTouchToFocusEnabled(Boolean touchToFocusEnabled)
Whether touch-to-focus is enabled on camera preview. -
-
Constructor Detail
-
LicensePlateScannerJsonConfiguration
LicensePlateScannerJsonConfiguration(String version, String screen, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, String finderTextHint, JsonColor finderTextHintColor, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, Integer minNumberOfRequiredFramesWithEqualRecognitionResult, Integer maximumNumberOfAccumulatedFrames, Boolean useButtonsAllCaps, Long significantShakeDelay, JsonLicensePlateScanStrategy scanStrategy, String confirmationDialogTitle, String confirmationDialogMessage, String confirmationDialogConfirmButtonTitle, String confirmationDialogRetryButtonTitle, JsonColor confirmationDialogAccentColor, Boolean confirmationDialogConfirmButtonFilled, JsonColor confirmationDialogConfirmButtonFilledTextColor, Boolean replaceCancelButtonWithIcon, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled)
-
-
Method Detail
-
getVersion
final String getVersion()
A version of the configuration object
-
setVersion
final Unit setVersion(String version)
A version of the configuration object
-
setScreen
final Unit setScreen(String screen)
The configuration object should be applied for this screen
-
getCameraModule
final JsonCameraModule getCameraModule()
The preferred camera module (default - BACK)
-
setCameraModule
final Unit setCameraModule(JsonCameraModule cameraModule)
The preferred camera module (default - BACK)
-
getCameraOverlayColor
final JsonColor getCameraOverlayColor()
Background color outside of the finder window.
-
setCameraOverlayColor
final Unit setCameraOverlayColor(JsonColor cameraOverlayColor)
Background color outside of the finder window.
-
getCancelButtonTitle
final String getCancelButtonTitle()
Title of the cancel button.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button.
-
getEnableCameraButtonTitle
final String getEnableCameraButtonTitle()
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
-
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.
-
getEnableCameraExplanationText
final String getEnableCameraExplanationText()
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.
-
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.
-
getFinderLineColor
final JsonColor getFinderLineColor()
Foreground color of the detection overlay.
-
setFinderLineColor
final Unit setFinderLineColor(JsonColor finderLineColor)
Foreground color of the detection overlay.
-
getFinderLineWidth
final Double getFinderLineWidth()
Width of finder frame border. Default is 2.
-
setFinderLineWidth
final Unit setFinderLineWidth(Double finderLineWidth)
Width of finder frame border. Default is 2.
-
getFinderTextHint
final String getFinderTextHint()
User guidance text below the finder view
-
setFinderTextHint
final Unit setFinderTextHint(String finderTextHint)
User guidance text below the finder view
-
getFinderTextHintColor
final JsonColor getFinderTextHintColor()
Foreground color of the description label.
-
setFinderTextHintColor
final Unit setFinderTextHintColor(JsonColor finderTextHintColor)
Foreground color of the description label.
-
getFlashEnabled
final Boolean getFlashEnabled()
Controls whether the flash should be initially enabled. The default value is FALSE.
-
setFlashEnabled
final Unit setFlashEnabled(Boolean flashEnabled)
Controls whether the flash should be initially enabled. The default value is FALSE.
-
getOrientationLockMode
final JsonOrientationLockMode getOrientationLockMode()
UI Interface orientation lock mode
-
setOrientationLockMode
final Unit setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
UI Interface orientation lock mode
-
getTopBarBackgroundColor
final JsonColor getTopBarBackgroundColor()
The background color of the top toolbar.
-
setTopBarBackgroundColor
final Unit setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
The background color of the top toolbar.
-
getTopBarButtonsActiveColor
final JsonColor getTopBarButtonsActiveColor()
The color of all active toggle buttons in the toolbar.
-
setTopBarButtonsActiveColor
final Unit setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)
The color of all active toggle buttons in the toolbar.
-
getTopBarButtonsInactiveColor
final JsonColor getTopBarButtonsInactiveColor()
The color of all inactive toggle buttons in the toolbar.
-
setTopBarButtonsInactiveColor
final Unit setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)
The color of all inactive toggle buttons in the toolbar.
-
getMinNumberOfRequiredFramesWithEqualRecognitionResult
final Integer getMinNumberOfRequiredFramesWithEqualRecognitionResult()
Minimum number of accumulated frames that have equal result
-
setMinNumberOfRequiredFramesWithEqualRecognitionResult
final Unit setMinNumberOfRequiredFramesWithEqualRecognitionResult(Integer minNumberOfRequiredFramesWithEqualRecognitionResult)
Minimum number of accumulated frames that have equal result
-
getMaximumNumberOfAccumulatedFrames
final Integer getMaximumNumberOfAccumulatedFrames()
Maximum number of accumulated frames to inspect before actual result is returned
-
setMaximumNumberOfAccumulatedFrames
final Unit setMaximumNumberOfAccumulatedFrames(Integer maximumNumberOfAccumulatedFrames)
Maximum number of accumulated frames to inspect before actual result is returned
-
getUseButtonsAllCaps
final Boolean getUseButtonsAllCaps()
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean useButtonsAllCaps)
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
-
getSignificantShakeDelay
final Long getSignificantShakeDelay()
Threshold used to pause the detection after significant movement occurred. -1 is default value. Default = 0 for textFilterStrategy='DOCUMENT' and 1000 for textFilterStrategy='LCD_DOT_MATRIX_DISPLAY'. Android only.
-
setSignificantShakeDelay
final Unit setSignificantShakeDelay(Long significantShakeDelay)
Threshold used to pause the detection after significant movement occurred. -1 is default value. Default = 0 for textFilterStrategy='DOCUMENT' and 1000 for textFilterStrategy='LCD_DOT_MATRIX_DISPLAY'. Android only.
-
getScanStrategy
final JsonLicensePlateScanStrategy getScanStrategy()
Detector mode, classic (OCR based) or ML (machine learning based) approach.
-
setScanStrategy
final Unit setScanStrategy(JsonLicensePlateScanStrategy scanStrategy)
Detector mode, classic (OCR based) or ML (machine learning based) approach.
-
getConfirmationDialogTitle
final String getConfirmationDialogTitle()
The title of the confirmation dialog.
-
setConfirmationDialogTitle
final Unit setConfirmationDialogTitle(String confirmationDialogTitle)
The title of the confirmation dialog.
-
getConfirmationDialogMessage
final String getConfirmationDialogMessage()
The message text of the confirmation dialog.
-
setConfirmationDialogMessage
final Unit setConfirmationDialogMessage(String confirmationDialogMessage)
The message text of the confirmation dialog.
-
getConfirmationDialogConfirmButtonTitle
final String getConfirmationDialogConfirmButtonTitle()
The title of the confirmation dialog retry button.
-
setConfirmationDialogConfirmButtonTitle
final Unit setConfirmationDialogConfirmButtonTitle(String confirmationDialogConfirmButtonTitle)
The title of the confirmation dialog retry button.
-
getConfirmationDialogRetryButtonTitle
final String getConfirmationDialogRetryButtonTitle()
The title of the confirmation dialog confirm button.
-
setConfirmationDialogRetryButtonTitle
final Unit setConfirmationDialogRetryButtonTitle(String confirmationDialogRetryButtonTitle)
The title of the confirmation dialog confirm button.
-
getConfirmationDialogAccentColor
final JsonColor getConfirmationDialogAccentColor()
The accent color of buttons on a confirmation dialog. Android only.
-
setConfirmationDialogAccentColor
final Unit setConfirmationDialogAccentColor(JsonColor confirmationDialogAccentColor)
The accent color of buttons on a confirmation dialog. Android only.
-
getConfirmationDialogConfirmButtonFilled
final Boolean getConfirmationDialogConfirmButtonFilled()
Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
-
setConfirmationDialogConfirmButtonFilled
final Unit setConfirmationDialogConfirmButtonFilled(Boolean confirmationDialogConfirmButtonFilled)
Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
-
getConfirmationDialogConfirmButtonFilledTextColor
final JsonColor getConfirmationDialogConfirmButtonFilledTextColor()
Allows to set a text color of the filled button. See
confirmationDialogConfirmButtonFilled
. Android only.
-
setConfirmationDialogConfirmButtonFilledTextColor
final Unit setConfirmationDialogConfirmButtonFilledTextColor(JsonColor confirmationDialogConfirmButtonFilledTextColor)
Allows to set a text color of the filled button. See
confirmationDialogConfirmButtonFilled
. Android only.
-
getReplaceCancelButtonWithIcon
final Boolean getReplaceCancelButtonWithIcon()
If
true
, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
-
setReplaceCancelButtonWithIcon
final Unit setReplaceCancelButtonWithIcon(Boolean replaceCancelButtonWithIcon)
If
true
, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
-
getCameraPreviewMode
final JsonCameraPreviewMode getCameraPreviewMode()
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
-
setCameraPreviewMode
final Unit setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
-
getTouchToFocusEnabled
final Boolean getTouchToFocusEnabled()
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
-
setTouchToFocusEnabled
final Unit setTouchToFocusEnabled(Boolean touchToFocusEnabled)
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
-
-
-
-