Class BaseBlinkIdUiSettings

    • Constructor Detail

      • BaseBlinkIdUiSettings

        protected BaseBlinkIdUiSettings​(@Nullable
                                        RecognizerBundle recognizerBundle)
      • BaseBlinkIdUiSettings

        protected BaseBlinkIdUiSettings​(@NonNull
                                        android.content.Intent intent)
    • Method Detail

      • setBeepSoundResourceID

        public void setBeepSoundResourceID​(@RawRes
                                           int beepSoundResourceID)
        Description copied from interface: BeepSoundUIOptions
        Defines the resource ID of the sound to be played when recognition is successful.
        Specified by:
        setBeepSoundResourceID in interface BeepSoundUIOptions
        Parameters:
        beepSoundResourceID - resource ID of the sound to be played when recognition is successful.
      • setDocumentDataMatchRequired

        public void setDocumentDataMatchRequired​(boolean isRequired)
        Description copied from interface: DocumentDataMatchUIOptions
        If set to true, user won't be able to finish the scanning process if data read from front and back sides doesn't match. This is applicable only when using combined recognizers.
        Specified by:
        setDocumentDataMatchRequired in interface DocumentDataMatchUIOptions
        Parameters:
        isRequired - true if you wish to enable document data matching
      • setDebugImageListener

        public void setDebugImageListener​(@Nullable
                                          DebugImageListener debugImageListener)
        Description copied from interface: DebugImageListenerUIOptions
        Sets implementation of DebugImageListener interface that will obtain images that are being processed. DebugImageListener will receive all possible debug images that become available during recognition process.
        Specified by:
        setDebugImageListener in interface DebugImageListenerUIOptions
        Parameters:
        debugImageListener - Implementation of debug image listener or null to clear listener that has been set previously.
      • setSplashScreenLayoutResourceID

        public void setSplashScreenLayoutResourceID​(int splashScreenLayoutResourceID)
        Description copied from interface: SplashScreenUIOptions
        Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized. If not set, default splash screen will be used.
        Specified by:
        setSplashScreenLayoutResourceID in interface SplashScreenUIOptions
        Parameters:
        splashScreenLayoutResourceID - ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.
      • setShowMrzDetection

        public void setShowMrzDetection​(boolean showOcrResult)
        Description copied from interface: MrzDetectionUIOptions
        Defines whether detection of MRZ(Machine Readable Zone) will be displayed in UI, default is true.
        Specified by:
        setShowMrzDetection in interface MrzDetectionUIOptions
        Parameters:
        showOcrResult - whether detection of MRZ(Machine Readable Zone) will be displayed in UI.
      • isLockedToPortrait

        protected abstract boolean isLockedToPortrait()
      • saveToIntent

        @CallSuper
        public void saveToIntent​(@NonNull
                                 android.content.Intent intent)
        Description copied from class: UISettings
        Saves this scan activity settings to Intent so it can be passed to the corresponding scan activity. Intent target activity must be set before calling this method, and target activity must be compatible with this settings. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.
        Overrides:
        saveToIntent in class UISettings<BlinkIdOverlayController>
        Parameters:
        intent - Intent to which this scan activity settings should be saved.