Class CheckRecognizerConfiguration
-
- All Implemented Interfaces:
public final class CheckRecognizerConfiguration
Class which is used to configure CheckRecognizerActivity Contains settings indicating views Behaviour, Texts and Appearance
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
CheckRecognizerConfiguration.Companion
-
Field Summary
Fields Modifier and Type Field Description private final CheckRecognizerJsonConfiguration
params
private final CheckScannerNativeConfiguration
nativeParams
public final static CheckRecognizerConfiguration.Companion
Companion
-
Constructor Summary
Constructors Constructor Description CheckRecognizerConfiguration()
-
Method Summary
Modifier and Type Method Description final CheckRecognizerJsonConfiguration
getParams()
final CheckScannerNativeConfiguration
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
setCaptureHighResolutionImage(Boolean captureHighResolutionImage)
Set high-resolution Check image capturing. final Unit
setAcceptedCheckStandards(ArrayList<RootDocumentType> acceptedCheckStandards)
Accepted checks. 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 inactive buttons in the top toolbar. final Unit
setFinderLineWidth(Integer finderLineWidth)
Thickness of the finder window's outline. final Unit
setFinderAspectRatio(AspectRatio finderAspectRatio)
Aspect ratio of the finder window. final Unit
setFinderLineColor(Integer finderLineColor)
Color of the finder window's outline. final Unit
setCameraOverlayColor(Integer cameraOverlayColor)
Background color outside of the finder window. final Unit
setCancelButtonTitle(String cancelButtonTitle)
Title 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
setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style. final Unit
setUserGuidanceBackgroundColor(Integer userGuidanceBackgroundColor)
The background color of the user guidance hints. final Unit
setUserGuidanceTextColor(Integer userGuidanceTextColor)
The text color of the user guidance hints. final Unit
setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. final Unit
setUserGuidanceStrings(String startScanning, String scanning, String capturing, String processing)
Configuration that helps to override default hint values. -
-
Method Detail
-
getParams
final CheckRecognizerJsonConfiguration getParams()
-
getNativeParams
final CheckScannerNativeConfiguration 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. 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.
-
setCaptureHighResolutionImage
final Unit setCaptureHighResolutionImage(Boolean captureHighResolutionImage)
Set high-resolution Check image capturing.
- Parameters:
captureHighResolutionImage
- If set to TRUE, a high-resolution photo of the check is captured to run the recognition on.
-
setAcceptedCheckStandards
final Unit setAcceptedCheckStandards(ArrayList<RootDocumentType> acceptedCheckStandards)
Accepted checks.
- Parameters:
acceptedCheckStandards
- A list of RootDocumentType (enum - RootDocumentType.USACheck, RootDocumentType.FRACheck, RootDocumentType.KWTCheck, RootDocumentType.AUSCheck, RootDocumentType.INDCheck, RootDocumentType.UnknownCheck, RootDocumentType.ISRCheck, RootDocumentType.UAECheck, RootDocumentType.CANCheck).
-
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 inactive buttons in the top toolbar.
-
setFinderLineWidth
final Unit setFinderLineWidth(Integer finderLineWidth)
Thickness of the finder window's outline.
-
setFinderAspectRatio
final Unit setFinderAspectRatio(AspectRatio finderAspectRatio)
Aspect ratio of the finder window.
-
setFinderLineColor
final Unit setFinderLineColor(Integer finderLineColor)
Color of the finder window's outline.
-
setCameraOverlayColor
final Unit setCameraOverlayColor(Integer cameraOverlayColor)
Background color outside of the finder window.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String cancelButtonTitle)
Title 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.
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style.
-
setUserGuidanceBackgroundColor
final Unit setUserGuidanceBackgroundColor(Integer userGuidanceBackgroundColor)
The background color of the user guidance hints.
-
setUserGuidanceTextColor
final Unit setUserGuidanceTextColor(Integer userGuidanceTextColor)
The text color of the user guidance hints.
-
setTouchToFocusEnabled
final Unit setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. Default is
true
.
-
setUserGuidanceStrings
final Unit setUserGuidanceStrings(String startScanning, String scanning, String capturing, String processing)
Configuration that helps to override default hint values.
- Parameters:
startScanning
-text that is shown on camera open.
scanning
-text that is shown when the camera is searching for the Check on the visible area, shown after the first result from the recognizer.
capturing
-text that is shown when the camera snaps the image.
processing
-text that is shown when the recognizer tries to detect the Check from the snapped image.
-
-
-
-