Interface CheckRecognizerConfiguration

interface CheckRecognizerConfiguration {
    acceptedCheckStandards?: CheckStandard[];
    cameraModule?: CameraModule;
    cameraOverlayColor?: string;
    cameraPreviewMode?: CameraPreviewMode;
    cancelButtonHidden?: boolean;
    cancelButtonTitle?: string;
    captureHighResolutionImage?: boolean;
    enableCameraButtonTitle?: string;
    enableCameraExplanationText?: string;
    errorAlertButtonText?: string;
    errorAlertMessage?: string;
    errorAlertTitle?: string;
    errorDialogButtonStyle?: DialogButtonStyle;
    errorDialogStyle?: DialogStyle;
    finderAspectRatio?: AspectRatio;
    finderLineColor?: string;
    finderLineWidth?: number;
    flashButtonHidden?: boolean;
    flashButtonTitle?: string;
    flashEnabled?: boolean;
    orientationLockMode?: OrientationLockMode;
    topBarBackgroundColor?: string;
    topBarButtonsActiveColor?: string;
    topBarButtonsInactiveColor?: string;
    touchToFocusEnabled?: boolean;
    useButtonsAllCaps?: boolean;
    userGuidanceBackgroundColor?: string;
    userGuidanceStringValues?: CheckUserGuidanceStrings;
    userGuidanceTextColor?: string;
}

Properties

acceptedCheckStandards?: CheckStandard[]

Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.

cameraModule?: CameraModule

The preferred camera module (default - BACK)

cameraOverlayColor?: string

Background color outside of the finder window.

cameraPreviewMode?: CameraPreviewMode

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

cancelButtonHidden?: boolean

Whether the cancel button is hidden or not. iOS only.

cancelButtonTitle?: string

Title of the cancel button.

captureHighResolutionImage?: boolean

Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.

enableCameraButtonTitle?: string

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

enableCameraExplanationText?: string

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.

errorAlertButtonText?: string

String being displayed as the button text in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.

errorAlertMessage?: string

String being displayed as the message in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.

errorAlertTitle?: string

String being displayed as the title in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.

errorDialogButtonStyle?: DialogButtonStyle

The style of the dialogs/alerts OK button in case of error. iOS Only.

errorDialogStyle?: DialogStyle

The style of the dialog/alert in case of error. iOS Only.

finderAspectRatio?: AspectRatio

Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.

finderLineColor?: string

Foreground color of the detection overlay.

finderLineWidth?: number

Width of finder frame border. Default is 2.

flashButtonHidden?: boolean

Controls whether the flash toggle button is hidden or not. iOS only.

flashButtonTitle?: string

Title of the flash toggle button. iOS only.

flashEnabled?: boolean

Controls whether the flash should be initially enabled. The default value is FALSE.

orientationLockMode?: OrientationLockMode

UI Interface orientation lock mode

topBarBackgroundColor?: string

The background color of the top toolbar.

topBarButtonsActiveColor?: string

The color of all active toggle buttons in the toolbar.

topBarButtonsInactiveColor?: string

The color of all inactive toggle buttons in the toolbar.

touchToFocusEnabled?: boolean

Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

useButtonsAllCaps?: boolean

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

userGuidanceBackgroundColor?: string

The background color of the user guidance hints.

userGuidanceStringValues?: CheckUserGuidanceStrings

Configuration that helps to override default hint values.

userGuidanceTextColor?: string

The text color of the user guidance hints.