# All Classes and Interfaces

Class
Description
ActivityRunner
Utility class that will start the activity associated with given `UISettings`
AdditionalProcessingInfo
AgeLimitStatus
AlphabetType
AnimationEndListener
AnonymizationMode
Defines level of anonymization performed on recognizer result.
AutofocusListener
BackSideScanningTimeoutUIOptions
BarcodeDriverLicenseDetailedInfo
Driver's license specific data extracted from barcode.
BarcodeElementKey
Enum defining additional fields present in the barcode.
BarcodeElements
Contains barcode elements scanned from the document.
BarcodeResult
Contains data extracted from the barcode.
BarcodeScanningStartedCallback
Callback that will be invoked when barcode scanning step starts.
BarcodeScanningStartedCallbackOptions
BarcodeType
Represents the type of scanned barcode
BarcodeVehicleClassInfo
The additional information on vehicle class extracted from barcode.
BaseBlinkIdUiSettings
BaseCameraEventsListener
BaseCameraView
Created by dodo on 25/08/16.
BaseCameraView.CameraViewState
BaseCameraView.VisiblePartUpdateListener
BaseOverlayController
BaseScanResult<T>
Result of the scanning process.
BeepSoundUIOptions
BlinkIdActivity
BlinkIdDialogOnboardingPresenter
BlinkIdDialogOnboardingView
BlinkIdMultiSideRecognizer
A generic recognizer which can scan front and back side of the document.
BlinkIdMultiSideRecognizer.Result
BlinkIdMultiSideRecognizer.VerificationConstants
Constants used for building JSON for the verification service, in case when result fields can be edited and/or inserted.
BlinkIdOverlayController
BlinkIdOverlaySettings
Collection of configuration settings for `BlinkIdOverlayController`.
BlinkIdOverlaySettings.Builder
Builds settings to be used with `BlinkIdOverlayController`
BlinkIdOverlaySettingsOptions<T>
BlinkIdOverlayView
BlinkIdOverlayView.ProcessingError
Supported processing errors.
BlinkIdSingleSideRecognizer
Generic BlinkID single side recognizer.
BlinkIdSingleSideRecognizer.Result
BlinkIdUISettings
CameraAspectMode
CameraEventsListener
CameraPermissionManager
Helper class that shows the camera permission screen when user has denied camera permission on Android 6.0+.
CameraSettings
CameraSettings.Builder
CameraType
CameraViewGroup
A simple wrapper around a Camera and a SurfaceView that renders a centered preview of the Camera to the surface.
CameraViewGroup.LayoutParams
Layout params for BaseCameraView.
CardOrientation
Defines possible card orientations.
CardRotation
Defines possible card rotations.
CharWithVariants
ClassAnonymizationSettings
ClassAnonymizationSettings.Builder
Only specified parameters will be taken into account during anonymization.
ClassFilter
Document filter that is used to determine which documents will be processed.
ClassifierCallback
Callback that will be invoked from the recognizer when document is classified.
ClassifierCallbackOptions
ClassInfo
Contains document class information.
ClassInfoResult
CombinedDataMatchResult
Interface that must be implemented by combined recognizers which support data matching feature.
CombinedFullDocumentImageResult
CombinedRecognizer
CombinedResult
Interface that must be implemented by all combined recognizers.
Country
Document country
CurrentImageListener
Callback that will be invoked when recognition process receives new frame for processing.
CurrentImageListenerUIOptions
CustomClassRules
Object representing custom rules of mandatory fields for each class of a document.
CustomClassRules.Builder
Builder for `CustomClassRules`.
DataMatchField
Fields for which the data match is performed.
DataMatchResult
Info on whether the data extracted from front image matches the data extracted from the back image.
DataMatchState
State of the data matching algorithm for scanned parts/sides of the document.
Date
Helper class for obtaining date results.
DateResult
Helper class for obtaining multialphabet date results.
DateUtils
DebugImageCallback
Callback that will be invoked when recognition process wishes to display a debug image.
DebugImageListener
Callback that will be invoked when recognition process wishes to display an image.
DebugImageListenerUIOptions
DebugTextCallback
Callback that will be invoked when debug text information gets available.
DebugViewHandler
DependentInfo
The dependent info.
DetailedFieldType
Class representing a detailed field type used for custom mandatory fields.
DetectionStatus
Indicates a detection status for detection result
DewarpedImageCallback
Callback that will be invoked from the recognizer when it has dewarped image to return.
DewarpPolicy
Base class for all dewarp policies.
DirectApiErrorListener
DisplayableDetection
Represents a detection that can be displayed on screen.
DisplayableObject
Represents any object that can be displayed on screen in terms of drawing.
DisplayableOcrResult
Represents an OCR result that can be drawn on screen.
DisplayablePointsDetection
Represents points of detection that can be displayed on screen.
DisplayableQuadDetection
Represents a quad-like detection that can be displayed on screen.
DocumentDataMatchUIOptions
DocumentFaceDetectorType
Possible supported detectors for documents containing face image
DocumentFaceRecognizer
Deprecated.
DocumentFaceRecognizer.Result
DocumentImageColorStatus
Defines possible color statuses determined from scanned image.
DocumentNotSupportedDialogUIOptions
DocumentNumberAnonymizationSettings
Holds the settings which control document number anonymization.
DocumentOverlayStrings
Deprecated.
DocumentOverlayStrings.Builder
DocumentOverlayView
Deprecated.
DocumentRecognizerManager
DocumentRecognizerManager.ConcreteRecognizerExtractor
DocumentScanActivity
Deprecated.
DocumentSide
DocumentUISettings
Deprecated.
DocumentViewfinderManager
Document viewfinder manager that should be used for showing the splash screens over the viewfinder.
DPIBasedDewarpPolicy
DPI based dewarp policy.
DpiOptionsUtils
DriverLicenseDetailedInfo
Driver'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
FaceImageDpiOptions
Options for configuring the DPI (Dots Per Inch) for face image in cases when it should be returned.
FaceImageOptions
FaceImageResult
FailedDetectionCallback
Callback that will be invoked when all detections in `Recognizer` chain have failed.
FieldState
Data match state for one field.
FieldType
FirstSideRecognitionCallback
Callback that will be invoked when first side recognition has completed.
FixedDewarpPolicy
Fixed dewarp policy.
FlashlightWarningUIOptions
FrameCallback
Callback that will be invoked from `FrameGrabberRecognizer` when it receives new frame for processing.
FrameGrabberRecognizer
A recognizer that never produces a result, but sends every frame that it receives to given `FrameCallback`.
FrameGrabberRecognizer.Result
FullDocumentImageDpiOptions
Options for configuring the DPI (Dots Per Inch) for full document image in cases when it should be returned.
FullDocumentImageExtensionOptions
Options for configuring the full document image extension.
FullDocumentImageOptions
FullDocumentImageResult
GlareCallback
Callback that will be invoked when glare detection has completed.
GlareDetectorOptions
Interface that should be implemented by settings for all recognizers that use glare detector.
HardwareInfo
HighResImagesBundle
HighResImageWrapper
Wrapper around `Image` used for high resolution images.
HighResImageWrapper.Factory
HighResSuccessFrameCaptureUIOptions
IdBarcodeDocumentType
Represents the type of scanned document
IdBarcodeRecognizer
Deprecated.
IdBarcodeRecognizer.Result
IDisplayablePointsView
Interface for views that can draw displayable points on the camera overlay.
Image
Represents a image that is being processed.
ImageAnalysisDetectionStatus
ImageAnalysisDetectionResult enum defines possible states of detection.
ImageAnalysisResult
Contains document image analysis information.
ImageBuilder
Utility class that can build `Image` object from various sources.
ImageExtensionFactors
Extension factors relative to corresponding dimension of the full image.
ImageExtractionType
ImageFormat
Represents a format of image that is being returned.
ImageFrame
ImageReturnProcessor
Processor that will simply save given image.
ImageReturnProcessor.Result
ImageUploadManager
InnerReticleAnimator
InnerReticleView
InputImage
Represents a image that is being processed.
IntentDataTransferMode
Intent 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.
InvalidLicenceKeyException
Thrown when invalid licence key is set to library.
IOcrResultView
Interface for views that can display `DisplayableOcrResult`.
JsonizableEntity
LanguageUtils
LegacyDocumentVerificationActivity
Deprecated.
LegacyDocumentVerificationOverlayStrings
Deprecated.
LegacyDocumentVerificationOverlayStrings.Builder
LegacyDocumentVerificationOverlayView
Deprecated.
LegacyDocumentVerificationUISettings
Deprecated.
LicenceKeyException
LicenceLockedException
Thrown when the active licence has been remotely locked.
LifecycleObserver
Observer that can observe lifecycle events of `RecognizerRunnerFragment`
MandatoryFieldType
MbScan
The Activity Result API's contract to launch scanning by using the provided `UISettings`.
MetadataCallbacks
Class that contains all possible metadata callbacks that can observe recognition process.
MicroblinkSDK
Entry 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.VerificationConstants
Constants used for building JSON for the verification service, in case when result fields can be edited and/or inserted.
MrtdDocumentType
Supported MRTD document types
MrtdRecognizer
Deprecated.
MrtdRecognizer.Result
MrtdSpecification
Class representing specification of MRTD (Machine Readable Travel Document) that can be detected with MRTDDetector.
MrtdSpecificationPreset
Available presets for creating `MrtdSpecification`s by using `MrtdSpecification.createFromPreset(MrtdSpecificationPreset)`
MrzDetectionUIOptions
MrzFilter
Filter for MRTDs (Machine Readable Travel Documents) that is used to determine which documents will be processed.
MrzResult
Represents data extracted from MRZ (Machine Readable Zone) of Machine Readable Travel Document (MRTD).
NoOpImageUploadManager
NotSupportedReason
Enum describing reason why scanning is not supported.
NoUpScalingDewarpPolicy
No upscaling dewarp policy.
OcrBlock
OcrCallback
Callback that will be invoked with displayable OCR result obtained during recognition process.
OcrChar
OcrCharsFeedbackHandler
OcrDotsFeedbackHandler
OcrFont
A list of fonts supported by BlinkOCR
OcrLine
OcrResult
Represents a raw OCR result.
OcrResultCharsView
OcrResultDisplayMode
Mode in which OCR result will be drawn on camera preview.
OcrResultDisplayUIOptions
OcrResultDotsView
View intended to be used as child view to `RecognizerRunnerView` It differs from OcrResultView as it renders `mNumberOfDots` dots as subviews and displays them along a line of detection.
OnActivityFlipListener
Listener that will notify you when activity flip has occurred.
OnboardingFragment
OnboardingPagerAdapter
OnboardingPresenter
OnboardingResourcesCreator
OnboardingView
OneSideDocumentScan
The Activity Result API's contract to launch scanning of a one-sided document with `BlinkIdUISettings` and `BlinkIdSingleSideRecognizer`.
OneSideScanResult
Result of the scanning process using `BlinkIdSingleSideRecognizer`.
OnSizeChangedListener
Created by dodo on 06/10/14.
Orientation
OrientationAllowedListener
Created by dodo on 07/10/14.
OverlayCameraSettings
OverlayCameraSettings.Builder
OverlayResources
OverlayState
OverlayStringsBuilder<Self,Key>
OverlayTorchStateListener
Listener that will be notified when camera torch state is updated by the overlay controller.
PageIndicatorView
ParcelableScanResultListener
Scan result listener that can be passed to the activity by intent extras.
PassportRecognizer
Deprecated.
PassportRecognizer.Result
Point
PointsDetectionCallback
A callback that will be invoked when `DisplayablePointsDetection` gets available.
PointSetFeedbackHandler
PointSetView
A view that can draw PointsDetectorResult.
PointsType
Represents a type of `DisplayablePointsDetection`.
ProcessingStatus
Detailed 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
ProcessorGroup
Class that represents a group of processors that will be executed on same dewarped image.
ProgressAnimator
ProgressView
QuadDetectionCallback
A callback that will be invoked when `DisplayableQuadDetection` gets available.
Quadrilateral
QuadViewAnimationListener
Listener that will be notified of QuadView's animation events.
QuadViewManager
Class that manages animated quadrilateral detection result view.
QuadViewManagerFactory
QuadViewPreset
RecognitionFeedbackHandler
RecognitionFeedbackHandlerFactory
RecognitionMode
RecognitionModeFilter
RecognitionModeFilter is used to enable/disable recognition of specific document groups.
RecognitionSuccessType
Type 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
RecognizerBundle
Represents a bundle of `Recognizer` objects that can travel via `Intent`
RecognizerBundle.FrameQualityEstimationMode
RecognizerBundle.RecognitionDebugMode
RecognizerCompatibility
RecognizerCompatibilityStatus
RecognizerRunner
RecognizerRunner singleton that can be used to perform recognition of Bitmaps and Images.
RecognizerRunner.State
RecognizerRunnerFragment
A wrapper around `RecognizerRunnerView` that automatically manages its lifecycle.
RecognizerRunnerFragment.ScanningOverlayBinder
This interface must be implemented by all activites that will host `RecognizerRunnerFragment`.
RecognizerRunnerView
A view that controls the camera and recognition procedure.
RecognizerUtils
Rectangle
Region
Document region
RemoteLicenceCheckException
Thrown when remote licence check is not possible to perform successfully, possibly due to network issues.
ResultStatus
Status of the scanning process.
ReticleOverlayStrings
ReticleOverlayStrings.Builder
ReticleOverlayStringsOptions<T>
ReticleOverlayView
ReticleUiState
ReticleView
ReticleView.Type
RetryDialogStrings
Just a collection of strings to be used for retry on error dialog.
ScanningOverlay
Interface which every overlay set on `RecognizerRunnerFragment` must implement.
ScanRecognitionMode
ScanResult
Result of the scanning process.
ScanResultListener
Listener that will be notified when recognition is done.
ScanSoundPlayer
ScanUIEventListener
Listener interface for handling various UI events during the scanning process.
ScanUIEventListenerUIOptions
ShakeCallback
Side
Side of the document.
SignatureImageDpiOptions
Options for configuring the DPI (Dots Per Inch) for signature image in cases when it should be returned.
SignatureImageOptions
SignatureImageResult
SignedPayload
SimpleDate
Simple class which represents immutable dates that are consisted of day, month and year.
SimpleDateResult
SnackbarManager
Specification
Base class for all specifications that can be used for detection.
SplashScreenUIOptions
StatusMessageMode
StatusTextManager
StatusTextStyler
StatusTextStyler.Default
StrictnessLevel
Strictness level for detection.
StringResult
Multi-alphabet String result.
StringsUIOptions<T>
StyleUIOptions
SuccessCallback
Callback that will be invoked when some asynchronous operation has finished.
SuccessFlashView
SuccessFrameGrabberRecognizer
A recognizer that holds the camera frame on which given recognizer's result has become valid.
SuccessFrameGrabberRecognizer.Result
TemplatingClass
Class that represents a specific class of documents when used within Templating API.
TemplatingClassifier
Classifier that should return true if document belongs to given `TemplatingClass`.
TemplatingRecognizer<R extends TemplatingRecognizer.Result>
Base of all recognizers that support Templating API.
TemplatingRecognizer.Result
TooltipManager
TorchController
TouchInterceptRelativeLayout
TouchInterceptRelativeLayout.TouchListener
TwoSideDocumentScan
The Activity Result API's contract to launch scanning of a document with `BlinkIdUISettings` and `BlinkIdMultiSideRecognizer`.
TwoSideScanResult
Result of the scanning process using `BlinkIdMultiSideRecognizer`.
Type
Document type
UISettings<ScanOverlayType extends ScanningOverlay>
Base class for all concrete scan activity settings classes.
UsdlCombinedRecognizer
Deprecated.
UsdlCombinedRecognizer.Result
UsdlCombinedRecognizer.VerificationConstants
Constants used for building JSON for the verification service, in case when result fields can be edited and/or inserted.
UsdlKeys
Possible keys that can be used for obtaining USDL result elements.
UsdlRecognizer
Deprecated.
UsdlRecognizer.Result
VehicleClassInfo
The additional information on vehicle class.
VideoResolutionPreset
Created by dodo on 26/10/15.
ViewfinderShapeView
View that draws border of the chosen shape, fills shape with chosen color and fills available space outside shape borders with chosen color.
ViewfinderShapeView.ShapeType
Supported shape types.
VisaRecognizer
Deprecated.
VisaRecognizer.Result
VizResult
Contains data extracted from the Visual Inspection Zone.