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? cameraModule? cameraOverlayColor? cameraPreviewMode? cancelButtonHidden? cancelButtonTitle? captureHighResolutionImage? enableCameraButtonTitle? enableCameraExplanationText? errorAlertButtonText? errorAlertMessage? errorAlertTitle? errorDialogButtonStyle? errorDialogStyle? finderAspectRatio? finderLineColor? finderLineWidth? flashButtonHidden? flashButtonTitle? flashEnabled? orientationLockMode? topBarBackgroundColor? topBarButtonsActiveColor? topBarButtonsInactiveColor? touchToFocusEnabled? useButtonsAllCaps? userGuidanceBackgroundColor? userGuidanceStringValues? userGuidanceTextColor?

Properties

Optional acceptedCheckStandards

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.

Optional cameraModule

cameraModule?: CameraModule

The preferred camera module (default - BACK)

Optional cameraOverlayColor

cameraOverlayColor?: string

Background color outside of the finder window.

Optional cameraPreviewMode

cameraPreviewMode?: CameraPreviewMode

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

Optional cancelButtonHidden

cancelButtonHidden?: boolean

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

Optional cancelButtonTitle

cancelButtonTitle?: string

Title of the cancel button.

Optional captureHighResolutionImage

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.

Optional enableCameraButtonTitle

enableCameraButtonTitle?: string

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

Optional enableCameraExplanationText

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.

Optional errorAlertButtonText

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.

Optional errorAlertMessage

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.

Optional errorAlertTitle

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.

Optional errorDialogButtonStyle

errorDialogButtonStyle?: DialogButtonStyle

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

Optional errorDialogStyle

errorDialogStyle?: DialogStyle

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

Optional finderAspectRatio

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.

Optional finderLineColor

finderLineColor?: string

Foreground color of the detection overlay.

Optional finderLineWidth

finderLineWidth?: number

Width of finder frame border. Default is 2.

Optional flashButtonHidden

flashButtonHidden?: boolean

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

Optional flashButtonTitle

flashButtonTitle?: string

Title of the flash toggle button. iOS only.

Optional flashEnabled

flashEnabled?: boolean

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

Optional orientationLockMode

orientationLockMode?: OrientationLockMode

UI Interface orientation lock mode

Optional topBarBackgroundColor

topBarBackgroundColor?: string

The background color of the top toolbar.

Optional topBarButtonsActiveColor

topBarButtonsActiveColor?: string

The color of all active toggle buttons in the toolbar.

Optional topBarButtonsInactiveColor

topBarButtonsInactiveColor?: string

The color of all inactive toggle buttons in the toolbar.

Optional touchToFocusEnabled

touchToFocusEnabled?: boolean

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

Optional useButtonsAllCaps

useButtonsAllCaps?: boolean

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

Optional userGuidanceBackgroundColor

userGuidanceBackgroundColor?: string

The background color of the user guidance hints.

Optional userGuidanceStringValues

userGuidanceStringValues?: CheckUserGuidanceStrings

Configuration that helps to override default hint values.

Optional userGuidanceTextColor

userGuidanceTextColor?: string

The text color of the user guidance hints.

Settings

Member Visibility

Theme

On This Page

acceptedCheckStandardscameraModulecameraOverlayColorcameraPreviewModecancelButtonHiddencancelButtonTitlecaptureHighResolutionImageenableCameraButtonTitleenableCameraExplanationTexterrorAlertButtonTexterrorAlertMessageerrorAlertTitleerrorDialogButtonStyleerrorDialogStylefinderAspectRatiofinderLineColorfinderLineWidthflashButtonHiddenflashButtonTitleflashEnabledorientationLockModetopBarBackgroundColortopBarButtonsActiveColortopBarButtonsInactiveColortouchToFocusEnableduseButtonsAllCapsuserGuidanceBackgroundColoruserGuidanceStringValuesuserGuidanceTextColor