Package com.regula.documentreader.api

Class DocumentReader

  • public final class DocumentReader
extends BaseDocumentReader
    Class, which provides API for easy MRZ recognizing and results receiving. Takes care of initializing and configuring all necessary resources.

    • Field Detail

      • availableScenarios

        public java.util.List<DocumentReaderScenario> availableScenarios
        List of supported processing scenarios

      • tag

        public java.lang.String tag
        session id

    • Method Detail

      • Instance

        public static DocumentReader Instance()
        This method returns a single instance of DocumentReader class

      • isReady

        public boolean isReady()
        Use this method, to check if document reader is ready to work
        Returns:
        true or false flag, indicating document reader is set up and ready

      • getStatus

        public java.lang.String getStatus()
        Use this method to receive document reader status
        Returns:
        string representation of document reader status

      • isRFIDAvailableForUse

        public boolean isRFIDAvailableForUse()
        Use this to check if RFID chip reading functionality is supported
        Returns:
        true if RFID chip reading is supported using NFC

      • isAuthenticatorAvailableForUse

        public boolean isAuthenticatorAvailableForUse()
        Use this to check if Mobile authenticator available for use
        Returns:
        true if available

      • initializeReader

        public void initializeReader​(Context context,
                             BleDeviceConfig config,
                             IDocumentReaderInitCompletion completion)
        Performs the resource loading and overall initialization of Document Reader instance asynchronously
        Parameters:
        context - Application's context
        config - Configuration structure instance, containing initialization parameters for BLE device
        completion - callback

      • initializeReader

        public void initializeReader​(Context context,
                             DocReaderConfig config,
                             IDocumentReaderInitCompletion completion)
        Performs the resource loading and overall initialization of Document Reader instance asynchronously The initialization is performed fully offline, although by default the SDK attempts to access the licensing server to keep your license updated. In this case it will require INTERNET permission
        Parameters:
        context - Application's context
        config - Configuration structure instance, containing initialization parameters
        completion - callback

      • startNewSession

        public void startNewSession()
        Use this method to let DocumentReader know, that it should perform cleanup of previous results

      • startNewPage

        public void startNewPage()
        Use this method to let DocumentReader know, that new page of the same document will be processed

      • recognizeImage

        public void recognizeImage​(Bitmap bitmap,
                           IDocumentReaderCompletion completion)
        Use this method to process single image (e.g. from gallery)
        Parameters:
        bitmap - image of document to be processed
        completion - callback

      • recognizeImage

        public void recognizeImage​(Context context,
                           byte[] data,
                           IDocumentReaderCompletion completion)
        Use this method to process an image in any format and perform manual crop
        Parameters:
        data - binary data
        completion - callback

      • recognizeImages

        public void recognizeImages​(Bitmap[] bitmaps,
                            IDocumentReaderCompletion completion)
        Use this method to process multiple images
        Parameters:
        bitmaps - images of documents to be processed
        completion - callback

      • recognizeImage

        public void recognizeImage​(Context context,
                           Bitmap bitmap,
                           IDocumentReaderCompletion completion)
        Use this method to process single image (e.g. from gallery) and perform manual crop
        Parameters:
        bitmap - image of document to be processed
        completion - callback

      • showScanner

        public void showScanner​(Context context,
                        IDocumentReaderCompletion completion)
        Use this method to open camera preview activity using default back camera, which will take care of passing frames to recognition engine and return results when ready from your context
        Parameters:
        context - The Context in which this PendingIntent should start
        completion - callback

      • showScanner

        public void showScanner​(Context context,
                        int cameraId,
                        IDocumentReaderCompletion completion)
        Use this method to open camera preview activity using specified camera, which will take care of passing frames to recognition engine and return results when ready
        Parameters:
        context - The Context in which this PendingIntent should start
        cameraId - ID of the camera to be used for video capturing
        completion - callback

      • stopScanner

        public void stopScanner​(Context context)
        Use this method to reg_close camera preview activity

      • readRFID

        public void readRFID​(IsoDep tag,
                     IDocumentReaderCompletion completion)
        Use this method, to read data from detected chip using NFC Pay attention that `rfidAction` with `DocReaderAction.NOTIFICATION` code calls in background thread.
        Parameters:
        tag - detected NFC object
        completion - callback

      • readRFID

        public void readRFID​(IsoDep tag,
                     IDocumentReaderCompletion completion,
                     IRfidReaderRequest request)
        Use this method, to read data from detected chip using NFC Pay attention that `rfidAction` with `DocReaderAction.NOTIFICATION` code calls in background thread.
        Parameters:
        tag - detected NFC object
        completion - callback
        request - callback

      • startRFIDReader

        public void startRFIDReader​(Context context,
                            IDocumentReaderCompletion completion)
        Use this method to open RFID chip reading activity, which will take care of detecting and reading chip using NFC Pay attention that `rfidAction` with `DocReaderAction.NOTIFICATION` code calls in background thread.
        Parameters:
        context - context to start RFID reader
        completion - callback

      • startRFIDReader

        public void startRFIDReader​(Context context,
                            IDocumentReaderCompletion completion,
                            IRfidReaderRequest request)
        Use this method to open RFID chip reading activity, which will take care of detecting and reading chip using NFC Pay attention that `rfidAction` with `DocReaderAction.NOTIFICATION` code calls in background thread.
        Parameters:
        context - context to start RFID reader
        completion - callback
        request - request certificates callback

      • startRFIDReader

        public void startRFIDReader​(Context context,
                            IDocumentReaderCompletion completion,
                            IRfidReaderRequest request,
                            IRfidNotificationCompletion notificationCompletion)
        Use this method to open RFID chip reading activity, which will take care of detecting and reading chip using NFC Pay attention that `rfidAction` with `DocReaderAction.NOTIFICATION` code calls in background thread.
        Parameters:
        context - A Context of the application package implementing this class.
        completion - callback
        request - request callback

      • stopRFIDReader

        public void stopRFIDReader​(Context context)
        Use this method to reg_close RFID chip reading activity

      • checkDatabaseUpdate

        public void checkDatabaseUpdate​(Context context,
                                java.lang.String databaseId,
                                ICheckDatabaseUpdate completion)
        Use this method to check database update internet permission required
        Parameters:
        databaseId - Database to be checked
        completion - callback

      • prepareDatabase

        public void prepareDatabase​(Context context,
                            java.lang.String databaseID,
                            IDocumentReaderPrepareCompletion completion)
        Use this method to check if document description database is present and download it, if not
        Parameters:
        databaseID - Database to be checked
        completion - callback

      • removeDatabase

        public boolean removeDatabase​(Context context)
        Use this method to completely delete documents database from application assets
        Parameters:
        context - current context
        Returns:
        true if and only if the database was removed

      • runAutoUpdate

        public void runAutoUpdate​(Context context,
                          java.lang.String databaseID,
                          IDocumentReaderPrepareCompletion completion)
        Use this method to download the latest document description database internet permission required
        Parameters:
        databaseID - Database to be updated
        completion - callback

      • cancelDBUpdate

        public boolean cancelDBUpdate​(Context context)
        Use this method to cancel downloading the document description database
        Returns:
        true if and only if the update database was cancelled

      • setEnableCoreLogs

        public void setEnableCoreLogs​(java.lang.Boolean enableLogs)
        function to enable core and api logs
        Parameters:
        enableLogs - true for enable logs

      • addPKDCertificates

        public void addPKDCertificates​(java.util.List<PKDCertificate> certificates)
        function which pass Rfid certificates to Core
        Parameters:
        certificates - list of certificates

      • clearPKDCertificates

        public void clearPKDCertificates()
        function which clear all certificates in Core

      • deinitializeReader

        public void deinitializeReader()
        Use this method to unload the Document Reader and free used resources

      • resetConfiguration

        public void resetConfiguration()
        Use this method to reset all parameters to their default values

      • setVideoEncoderCompletion

        public void setVideoEncoderCompletion​(IVideoEncoderCompletion completion)
        Set completion to this method when you want to receive with video file of current session
        Parameters:
        completion - callback, see more IVideoEncoderCompletion

      • getVideoCaptureSessionId

        public java.lang.String getVideoCaptureSessionId()
        Method to get current video capture session id
        Returns:
        returns guid as string

      • setTccParams

        public void setTccParams​(TccParams tccParams,
                         ITccParamsCompletion completion)
        Set up TCC params
        Parameters:
        tccParams - input params
        completion - completion block