Class TextDataScannerConfiguration
-
- All Implemented Interfaces:
public final class TextDataScannerConfiguration
Class which is used to configure TextDataScannerActivity Contains settings indicating view's behaviour, texts and appearance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
TextDataScannerConfiguration.Companion
-
Field Summary
Fields Modifier and Type Field Description private final TextDataScannerJsonConfiguration
config
private final TextDataScannerNativeConfiguration
nativeConfig
public final static TextDataScannerConfiguration.Companion
Companion
-
Constructor Summary
Constructors Constructor Description TextDataScannerConfiguration(TextDataScannerStep step)
TextDataScannerConfiguration(TextDataScannerJsonConfiguration config, TextDataScannerNativeConfiguration nativeConfig)
-
Method Summary
Modifier and Type Method Description final TextDataScannerJsonConfiguration
getConfig()
final TextDataScannerNativeConfiguration
getNativeConfig()
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
setFinderTextHintColor(Integer finderTextHintColor)
The color of the text with user guidance below the finder view. final Unit
setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button. final Unit
setCancelButtonIcon(Integer cancelButtonIcon)
Icon of the cancel 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
setWordBoxHighlightColor(Integer color)
The color of the highlight of the wordboxes founded on the frame. final Unit
setWordBoxHighlightEnabled(Boolean enabled)
If the wordboxes should be highlighted when were found on the frame. final Unit
setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(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
setOcrResolutionLimit(Integer ocrResolutionLimit)
The image will be downscaled to the given value during the processing. final Unit
setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style. final Unit
setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled.
-
-
-
Constructor Detail
-
TextDataScannerConfiguration
TextDataScannerConfiguration(TextDataScannerStep step)
-
TextDataScannerConfiguration
TextDataScannerConfiguration(TextDataScannerJsonConfiguration config, TextDataScannerNativeConfiguration nativeConfig)
-
-
Method Detail
-
getConfig
final TextDataScannerJsonConfiguration getConfig()
-
getNativeConfig
final TextDataScannerNativeConfiguration getNativeConfig()
-
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.
-
setFinderTextHintColor
final Unit setFinderTextHintColor(Integer finderTextHintColor)
The color of the text with user guidance below the finder view.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button.
-
setCancelButtonIcon
final Unit setCancelButtonIcon(Integer cancelButtonIcon)
Icon of the cancel button.
-
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.
-
setWordBoxHighlightColor
final Unit setWordBoxHighlightColor(Integer color)
The color of the highlight of the wordboxes founded on the frame.
-
setWordBoxHighlightEnabled
final Unit setWordBoxHighlightEnabled(Boolean enabled)
If the wordboxes should be highlighted when were found on the frame.
-
setMinimumNumberOfRequiredFramesWithEqualRecognitionResult
final Unit setMinimumNumberOfRequiredFramesWithEqualRecognitionResult(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.
-
setOcrResolutionLimit
final Unit setOcrResolutionLimit(Integer ocrResolutionLimit)
The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower
0 - do not rescale.
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style.
-
setTouchToFocusEnabled
final Unit setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. Default is
true
.
-
-