Interface VinScannerConfiguration

interface VinScannerConfiguration {
    aspectRatio?: AspectRatio;
    cameraModule?: CameraModule;
    cameraOverlayColor?: string;
    cameraPreviewMode?: CameraPreviewMode;
    cancelButtonHidden?: boolean;
    cancelButtonTitle?: string;
    enableCameraButtonTitle?: string;
    enableCameraExplanationText?: string;
    finderLineColor?: string;
    finderLineWidth?: number;
    finderTextHintColor?: string;
    flashButtonHidden?: boolean;
    flashButtonTitle?: string;
    flashEnabled?: boolean;
    guidanceText?: string;
    maximumNumberOfAccumulatedFrames?: number;
    minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number;
    ocrResolutionLimit?: number;
    orientationLockMode?: OrientationLockMode;
    replaceCancelButtonWithIcon?: boolean;
    significantShakeDelay?: number;
    topBarBackgroundColor?: string;
    topBarButtonsActiveColor?: string;
    topBarButtonsInactiveColor?: string;
    touchToFocusEnabled?: boolean;
    useButtonsAllCaps?: boolean;
}

Properties

aspectRatio? cameraModule? cameraOverlayColor? cameraPreviewMode? cancelButtonHidden? cancelButtonTitle? enableCameraButtonTitle? enableCameraExplanationText? finderLineColor? finderLineWidth? finderTextHintColor? flashButtonHidden? flashButtonTitle? flashEnabled? guidanceText? maximumNumberOfAccumulatedFrames? minimumNumberOfRequiredFramesWithEqualRecognitionResult? ocrResolutionLimit? orientationLockMode? replaceCancelButtonWithIcon? significantShakeDelay? topBarBackgroundColor? topBarButtonsActiveColor? topBarButtonsInactiveColor? touchToFocusEnabled? useButtonsAllCaps?

Properties

Optional aspectRatio

aspectRatio?: AspectRatio

The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

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 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 finderLineColor

finderLineColor?: string

Foreground color of the detection overlay.

Optional finderLineWidth

finderLineWidth?: number

Width of finder frame border. Default is 2.

Optional finderTextHintColor

finderTextHintColor?: string

Foreground color of the description label.

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 guidanceText

guidanceText?: string

User guidance hint text.

Optional maximumNumberOfAccumulatedFrames

maximumNumberOfAccumulatedFrames?: number

Maximum number of accumulated frames to inspect before actual result is returned

Optional minimumNumberOfRequiredFramesWithEqualRecognitionResult

minimumNumberOfRequiredFramesWithEqualRecognitionResult?: number

Minimum number of accumulated frames that have equal result

Optional ocrResolutionLimit

ocrResolutionLimit?: number

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. Default value is 0.

Optional orientationLockMode

orientationLockMode?: OrientationLockMode

UI Interface orientation lock mode

Optional replaceCancelButtonWithIcon

replaceCancelButtonWithIcon?: boolean

If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.

Optional significantShakeDelay

significantShakeDelay?: number

Threshold used to pause the detection after significant movement occurred. Default = 0. Android only.

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.

Settings

Member Visibility

Theme

On This Page

aspectRatiocameraModulecameraOverlayColorcameraPreviewModecancelButtonHiddencancelButtonTitleenableCameraButtonTitleenableCameraExplanationTextfinderLineColorfinderLineWidthfinderTextHintColorflashButtonHiddenflashButtonTitleflashEnabledguidanceTextmaximumNumberOfAccumulatedFramesminimumNumberOfRequiredFramesWithEqualRecognitionResultocrResolutionLimitorientationLockModereplaceCancelButtonWithIconsignificantShakeDelaytopBarBackgroundColortopBarButtonsActiveColortopBarButtonsInactiveColortouchToFocusEnableduseButtonsAllCaps