capacitor-plugin-scanbot-sdk
    Preparing search index...

    Type Alias DocumentCustomUIGeneralConfiguration

    type DocumentCustomUIGeneralConfiguration = {
        autoSnappingDelay?: number;
        autoSnappingEnabled?: boolean;
        autoSnappingSensitivity?: number;
        detectDocumentAfterSnap?: boolean;
        photoQualityPrioritization?: CapturePhotoQualityPrioritization;
    }
    Index

    Properties

    autoSnappingDelay? autoSnappingEnabled? autoSnappingSensitivity? detectDocumentAfterSnap? photoQualityPrioritization?

    Properties

    autoSnappingDelay?: number

    The minimum delay in seconds between two consecutive automatic image captures. iOS only. Default is 1.0

    autoSnappingEnabled?: boolean

    When auto-snapping is enabled the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode the user can still tap the shutter button to snap a document. Default is true

    autoSnappingSensitivity?: number

    Controls the auto-snapping speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. Default is 0.66

    detectDocumentAfterSnap?: boolean

    Whether to detect the document after snapping. If enabled, the document scanner will try to detect the document in the captured image and provide the cropped image of the detected document along with the document detection result in the onSnappedDocumentResult callback. If disabled, only the original image is provided in the onSnappedDocumentResult callback and no document detection is performed on the captured image. Enabling this option may result in a longer processing time after snapping a document, especially on older devices.

    Default is true

    photoQualityPrioritization?: CapturePhotoQualityPrioritization

    The prioritization of still image quality and capturing speed. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: It has no effect on devices prior to iOS 13.0!. Default is BALANCED

    Settings

    Member Visibility

    On This Page

    Properties