All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description ActivityRunnerUtility class that will start the activity associated with given
AgeLimitStatus AnonymizationModeDefines level of anonymization performed on recognizer result. AutofocusListener BackSideScanningTimeoutUIOptions BarcodeElementKeyEnum defining additional fields present in the barcode. BarcodeElementsContains barcode elements scanned from the document. BarcodeResultContains data extracted from the barcode. BarcodeScanningStartedCallbackCallback that will be invoked when barcode scanning step starts. BarcodeScanningStartedCallbackOptions BarcodeTypeRepresents the type of scanned barcode BaseBlinkIdOverlayController BaseBlinkIdUiSettings BaseCameraEventsListener BaseCameraViewCreated by dodo on 25/08/16. BaseCameraView.CameraViewState BaseCameraView.VisiblePartUpdateListener BaseOverlayController BeepSoundUIOptions BlinkIdActivity BlinkIdCombinedRecognizerA generic recognizer which can scan front and back side of the document. BlinkIdCombinedRecognizer.Result BlinkIdCombinedRecognizer.VerificationConstantsConstants used for building JSON for the verification service, in case when result fields can be edited and/or inserted. BlinkIdOverlayController BlinkIdOverlaySettingsCollection of configuration settings for
BlinkIdOverlaySettings.BuilderBuilds settings to be used with
BlinkIdOverlaySettingsOptions<T> BlinkIdOverlayView BlinkIdOverlayView.ProcessingErrorSupported processing errors. BlinkIdRecognizerGeneric BlinkID recognizer. BlinkIdRecognizer.Result BlinkIdUISettings CameraAspectMode CameraEventsListener CameraPermissionManagerHelper class that shows the camera permission screen when user has denied camera permission on Android 6.0+. CameraSettings CameraSettings.Builder CameraType CameraViewGroupA simple wrapper around a Camera and a SurfaceView that renders a centered preview of the Camera to the surface. CameraViewGroup.LayoutParamsLayout params for BaseCameraView. CharWithVariants ClassFilterDocument filter that is used to determine which documents will be processed. ClassifierCallbackCallback that will be invoked from the recognizer when document is classified. ClassifierCallbackOptions ClassInfoContains document class information. ClassInfoResult CombinedDataMatchResultInterface that must be implemented by combined recognizers which support data matching feature. CombinedFullDocumentImageResult CombinedRecognizer CombinedResultInterface that must be implemented by all combined recognizers. CountryDocument country CurrentImageListenerCallback that will be invoked when recognition process receives new frame for processing. CurrentImageListenerUIOptions DataMatchDetailedInfoDetailed info of a document data match. DataMatchResultResult of the data matching algorithm for scanned parts/sides of the document. DateSimple class which represents immutable dates that are consisted of day, month and year. DateResultHelper class for obtaining date results. DateUtils DebugImageCallbackCallback that will be invoked when recognition process wishes to display a debug image. DebugImageListenerCallback that will be invoked when recognition process wishes to display an image. DebugImageListenerUIOptions DebugTextCallbackCallback that will be invoked when debug text information gets available. DebugViewHandler DetectionStatusIndicates a detection status for detection result DewarpedImageCallbackCallback that will be invoked from the recognizer when it has dewarped image to return. DewarpPolicyBase class for all dewarp policies. DirectApiErrorListener DisplayableDetectionRepresents a detection that can be displayed on screen. DisplayableObjectRepresents any object that can be displayed on screen in terms of drawing. DisplayableOcrResultRepresents an OCR result that can be drawn on screen. DisplayablePointsDetectionRepresents points of detection that can be displayed on screen. DisplayableQuadDetectionRepresents a quad-like detection that can be displayed on screen. DocumentDataMatchUIOptions DocumentFaceDetectorTypePossible supported detectors for documents containing face image DocumentFaceRecognizer Deprecated. DocumentFaceRecognizer.Result DocumentImageColorStatusDefines possible color statuses determined from scanned image. DocumentNotSupportedDialogUIOptions DocumentOverlayStrings DocumentOverlayStrings.Builder DocumentOverlayView DocumentRecognizerManager DocumentRecognizerManager.ConcreteRecognizerExtractor DocumentScanActivity DocumentSide DocumentUISettingsScan settings for scanning documents. DocumentViewfinderManagerDocument viewfinder manager that should be used for showing the splash screens over the viewfinder. DPIBasedDewarpPolicyDPI based dewarp policy. DpiOptionsUtils DriverLicenseDetailedInfoDriver's license specific data. EncodedCombinedFullDocumentImageResult EncodedFaceImageResult EncodedFullDocumentImageResult EncodedSignatureImageResult EncodeFaceImageOptions EncodeFullDocumentImagesOptions EncodeSignatureImageOptions Entity<T extends Entity.Result>Represents an entity that can be process a step during recognition. Entity.Result ErrorDialogFactory FaceImageDpiOptionsOptions for configuring the DPI (Dots Per Inch) for face image in cases when it should be returned. FaceImageOptions FaceImageResult FailedDetectionCallbackCallback that will be invoked when all detections in
Recognizerchain have failed.
FirstSideRecognitionCallbackCallback that will be invoked when first side recognition has completed. FixedDewarpPolicyFixed dewarp policy. FlashlightWarningUIOptions FrameCallbackCallback that will be invoked from
FrameGrabberRecognizerwhen it receives new frame for processing.
FrameGrabberRecognizerA recognizer that never produces a result, but sends every frame that it receives to given
FrameGrabberRecognizer.Result FullDocumentImageDpiOptionsOptions for configuring the DPI (Dots Per Inch) for full document image in cases when it should be returned. FullDocumentImageExtensionOptionsOptions for configuring the full document image extension. FullDocumentImageOptions FullDocumentImageResult GlareCallbackCallback that will be invoked when glare detection has completed. GlareDetectorOptionsInterface that should be implemented by settings for all recognizers that use glare detector. HardwareInfo HighResImagesBundle HighResImageWrapperWrapper around
Imageused for high resolution images.
HighResImageWrapper.Factory HighResSuccessFrameCaptureUIOptions IdBarcodeDocumentTypeRepresents the type of scanned document IdBarcodeRecognizerThe ID Barcode Recognizer is used for scanning ID Barcode. IdBarcodeRecognizer.Result IDisplayablePointsViewInterface for views that can draw displayable points on the camera overlay. ImageRepresents a image that is being processed. ImageAnalysisDetectionStatusImageAnalysisDetectionResult enum defines possible states of detection. ImageAnalysisResultContains document image analysis information. ImageBuilderUtility class that can build
Imageobject from various sources.
ImageExtensionFactorsExtension factors relative to corresponding dimension of the full image. ImageFormatRepresents a format of image that is being returned. ImageFrame ImageReturnProcessorProcessor that will simply save given image. ImageReturnProcessor.Result ImageTypeDefines the type of image that is being returned. ImageUploadManager IntentDataTransferModeIntent data transfer mode which is used for transferring Microblink SDK data between activities. IntentTransferableEntity<E extends Entity>Helper class whose concrete implementations can be used for transferring single entity over intent. InvalidLicenceKeyExceptionThrown when invalid licence key is set to library. IOcrResultViewInterface for views that can display
JsonizableEntity LanguageUtils LegacyDocumentVerificationActivity Deprecated. LegacyDocumentVerificationOverlayStrings Deprecated. LegacyDocumentVerificationOverlayStrings.Builder LegacyDocumentVerificationOverlayView Deprecated. LegacyDocumentVerificationUISettings Deprecated. LicenceKeyException LicenceLockedExceptionThrown when the active licence has been remotely locked. LifecycleObserverObserver that can observe lifecycle events of
MbScanThe Activity Result API's contract to launch scanning by using the provided
MetadataCallbacksClass that contains all possible metadata callbacks that can observe recognition process. MicroblinkSDKEntry class for all Microblink SDKs - used for setting up license key and to add support for optimisation of passing data between activities. MrtdCombinedRecognizer Deprecated. MrtdCombinedRecognizer.Result MrtdCombinedRecognizer.VerificationConstantsConstants used for building JSON for the verification service, in case when result fields can be edited and/or inserted. MrtdDocumentTypeSupported MRTD document types MrtdRecognizer Deprecated. MrtdRecognizer.Result MrtdSpecificationClass representing specification of MRTD (Machine Readable Travel Document) that can be detected with MRTDDetector. MrtdSpecificationPresetAvailable presets for creating
MrtdSpecifications by using
MrzDetectionUIOptions MrzFilterFilter for MRTDs (Machine Readable Travel Documents) that is used to determine which documents will be processed. MrzResultRepresents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD). NoOpImageUploadManager NotSupportedReasonEnum describing reason why scanning is not supported. NoUpScalingDewarpPolicyNo upscaling dewarp policy. OcrBlock OcrCallbackCallback that will be invoked with displayable OCR result obtained during recognition process. OcrChar OcrCharsFeedbackHandler OcrDotsFeedbackHandler OcrFontA list of fonts supported by BlinkOCR OcrLine OcrResultRepresents a raw OCR result. OcrResultCharsView OcrResultDisplayModeMode in which OCR result will be drawn on camera preview. OcrResultDisplayUIOptions OcrResultDotsViewView intended to be used as child view to
RecognizerRunnerViewIt differs from OcrResultView as it renders
mNumberOfDotsdots as subviews and displays them along a line of detection.
OnActivityFlipListenerListener that will notify you when activity flip has occurred. OnSizeChangedListenerCreated by dodo on 06/10/14. Orientation OrientationAllowedListenerCreated by dodo on 07/10/14. OverlayCameraSettings OverlayCameraSettings.Builder OverlayResources OverlayState OverlayStringsBuilder<Self,Key> OverlayTorchStateListenerListener that will be notified when camera torch state is updated by the overlay controller. ParcelableScanResultListenerScan result listener that can be passed to the activity by intent extras. PassportRecognizer Deprecated. PassportRecognizer.Result Point PointsDetectionCallbackA callback that will be invoked when
PointSetFeedbackHandler PointSetViewA view that can draw PointsDetectorResult. PointsTypeRepresents a type of
ProcessingStatusDetailed information about the recognition process. ProcessingStatusResult Processor<T extends Processor.Result>Base processor that is used to perform processing of images. Processor.Result Processor.Result.State ProcessorGroupClass that represents a group of processors that will be executed on same dewarped image. PulseView QuadDetectionCallbackA callback that will be invoked when
Quadrilateral QuadViewAnimationListenerListener that will be notified of QuadView's animation events. QuadViewManagerClass that manages animated quadrilateral detection result view. QuadViewManagerFactory QuadViewPreset RecognitionFeedbackHandler RecognitionFeedbackHandlerFactory RecognitionMode RecognitionModeFilterRecognitionModeFilter is used to enable/disable recognition of specific document groups. RecognitionSuccessTypeType of recognition that has been performed. Recognizer<T extends Recognizer.Result>Base recognizer that is used to perform recognition of images. Recognizer.Result Recognizer.Result.State RecognizerBundleRepresents a bundle of
Recognizerobjects that can travel via
RecognizerBundle.FrameQualityEstimationMode RecognizerBundle.RecognitionDebugMode RecognizerCompatibility RecognizerCompatibilityStatus RecognizerRunnerRecognizerRunner singleton that can be used to perform recognition of Bitmaps and Images. RecognizerRunner.State RecognizerRunnerFragmentA wrapper around
RecognizerRunnerViewthat automatically manages its lifecycle.
RecognizerRunnerFragment.ScanningOverlayBinderThis interface must be implemented by all activites that will host
RecognizerRunnerViewA view that controls the camera and recognition procedure. RecognizerUtils Rectangle RegionDocument region RemoteLicenceCheckExceptionThrown when remote licence check is not possible to perform successfully, possibly due to network issues. ResultRepresents abstract result that can be returned by
ReticleOverlayStrings ReticleOverlayStrings.Builder ReticleOverlayStringsOptions<T> ReticleOverlayView ReticleUiState ReticleView ReticleView.Type RetryDialogStringsJust a collection of strings to be used for retry on error dialog. ScanningOverlayInterface which every overlay set on
ScanResultResult of the scanning process. ScanResult.ResultStatusStatus of the scanning process. ScanResultListenerListener that will be notified when recognition is done. ScanSoundPlayer ShakeCallback SignatureImageDpiOptionsOptions for configuring the DPI (Dots Per Inch) for signature image in cases when it should be returned. SignatureImageOptions SignatureImageResult SignedPayload SnackbarManager SpecificationBase class for all specifications that can be used for detection. SplashScreenUIOptions StatusTextManager StatusTextStyler StatusTextStyler.Default StringsUIOptions<T> StyleUIOptions SuccessCallbackCallback that will be invoked when some asynchronous operation has finished. SuccessFlashView SuccessFrameGrabberRecognizerA recognizer that holds the camera frame on which given recognizer's result has become valid. SuccessFrameGrabberRecognizer.Result TemplatingClassClass that represents a specific class of documents when used within Templating API. TemplatingClassifierClassifier that should return true if document belongs to given
TemplatingRecognizer<R extends TemplatingRecognizer.Result>Base of all recognizers that support Templating API. TemplatingRecognizer.Result TorchController TouchInterceptRelativeLayout TouchInterceptRelativeLayout.TouchListener TypeDocument type UISettings<ScanOverlayType extends ScanningOverlay>Base class for all concrete scan activity settings classes. UsdlCombinedRecognizer Deprecated. UsdlCombinedRecognizer.Result UsdlCombinedRecognizer.VerificationConstantsConstants used for building JSON for the verification service, in case when result fields can be edited and/or inserted. UsdlKeysPossible keys that can be used for obtaining USDL result elements. UsdlRecognizer Deprecated. UsdlRecognizer.Result VehicleClassInfoThe additional information on vehicle class. VideoResolutionPresetCreated by dodo on 26/10/15. ViewfinderShapeViewView that draws border of the chosen shape, fills shape with chosen color and fills available space outside shape borders with chosen color. ViewfinderShapeView.ShapeTypeSupported shape types. VisaRecognizer Deprecated. VisaRecognizer.Result VizResultContains data extracted from the Visual Inspection Zone.