--- Source: https://docs.microblink.com/blinkcard/v2/sdk/web/api-ref Title: API reference (Web SDK) Description: Complete API reference documentation for BlinkCard Web SDK classes, methods, and interfaces --- # API reference (Web SDK) ## Enumerations ### PreferredCameraType Defined in: [src/MicroblinkSDK/CameraUtils.ts:8](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L8) Preferred type of camera to be used when opening the camera feed. #### Enumeration Members ##### BackFacingCamera > **BackFacingCamera**: `0` Defined in: [src/MicroblinkSDK/CameraUtils.ts:11](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L11) Prefer back facing camera ##### FrontFacingCamera > **FrontFacingCamera**: `1` Defined in: [src/MicroblinkSDK/CameraUtils.ts:13](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L13) Prefer front facing camera *** ### ImageOrientation Defined in: [src/MicroblinkSDK/DataStructures.ts:18](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L18) Specifies the orientation of the contents of the image. This is important for some recognizers, especially when performing recognition on the mobile device. #### Enumeration Members ##### RotatedLeft90 > **RotatedLeft90**: `0` Defined in: [src/MicroblinkSDK/DataStructures.ts:26](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L26) Image contents are rotated 90 degrees left. This usually happens on mobile devices when capturing image while device is held in "portrait" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation). ##### NoRotation > **NoRotation**: `1` Defined in: [src/MicroblinkSDK/DataStructures.ts:36](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L36) Image contents are not rotated in any manner. This is the default for images captured using HTML canvas, as used in FrameCapture class. This orientation also usually happens on mobile devices when capturing image while device is held in "landscape" orientation, while device camera sensor is mounted horizontally (i.e. also in same orientation). ##### RotatedRight90 > **RotatedRight90**: `2` Defined in: [src/MicroblinkSDK/DataStructures.ts:44](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L44) Image contents are rotated 90 degrees right. This usually happens on mobile devices when capturing image while device is held in "reverse-portrait" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation). ##### Rotated180 > **Rotated180**: `3` Defined in: [src/MicroblinkSDK/DataStructures.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L52) Image contents are rotated 180 degrees, i.e. image contents are "upside down". This usually happens on mobile devices when capturing image while device is held in "reverse-landscape" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation). *** ### RecognizerResultState Defined in: [src/MicroblinkSDK/DataStructures.ts:58](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L58) Specifies the state of the recognition result. #### Enumeration Members ##### Empty > **Empty**: `0` Defined in: [src/MicroblinkSDK/DataStructures.ts:61](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L61) Nothing has been recognized. ##### Uncertain > **Uncertain**: `1` Defined in: [src/MicroblinkSDK/DataStructures.ts:63](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L63) Something has been recognized, but some mandatory data is still missing. ##### Valid > **Valid**: `2` Defined in: [src/MicroblinkSDK/DataStructures.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L65) All required data has been recognized. ##### StageValid > **StageValid**: `3` Defined in: [src/MicroblinkSDK/DataStructures.ts:67](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L67) Single stage of a multi-stage recognition is finished. *** ### DetectionLevel Defined in: [src/MicroblinkSDK/DetectionLevel.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DetectionLevel.ts#L12) Represents the different levels of detection sensitivity. This enum class is used to configure detection thresholds and enable or disable detection functionality. The levels range from turning detection off completely to setting various levels of sensitivity (Low, Mid, High). #### Enumeration Members ##### Off > **Off**: `0` Defined in: [src/MicroblinkSDK/DetectionLevel.ts:13](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DetectionLevel.ts#L13) ##### Low > **Low**: `1` Defined in: [src/MicroblinkSDK/DetectionLevel.ts:14](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DetectionLevel.ts#L14) ##### Mid > **Mid**: `2` Defined in: [src/MicroblinkSDK/DetectionLevel.ts:15](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DetectionLevel.ts#L15) ##### High > **High**: `3` Defined in: [src/MicroblinkSDK/DetectionLevel.ts:16](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DetectionLevel.ts#L16) *** ### DocumentSide Defined in: [src/MicroblinkSDK/DocumentSide.ts:9](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DocumentSide.ts#L9) The side of the document. #### Enumeration Members ##### Front > **Front**: `0` Defined in: [src/MicroblinkSDK/DocumentSide.ts:11](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DocumentSide.ts#L11) ##### Back > **Back**: `1` Defined in: [src/MicroblinkSDK/DocumentSide.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DocumentSide.ts#L12) *** ### ErrorCodes Defined in: [src/MicroblinkSDK/ErrorTypes.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L12) Structures of Error Codes, Error Messages, and CustomError compatible objects for the Error Generator utility. Error Code convention: SECTION_OBJECT_(ACTION)_PROBLEM #### Enumeration Members ##### WORKER\_WASM\_LOAD\_FAILURE > **WORKER\_WASM\_LOAD\_FAILURE**: `"WORKER_WASM_LOAD_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:13](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L13) ##### WORKER\_WASM\_INIT\_MISSING > **WORKER\_WASM\_INIT\_MISSING**: `"WORKER_WASM_INIT_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:14](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L14) ##### WORKER\_FUNCTION\_INVOKE\_FAILURE > **WORKER\_FUNCTION\_INVOKE\_FAILURE**: `"WORKER_FUNCTION_INVOKE_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:15](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L15) ##### WORKER\_RECOGNIZER\_CREATION\_FAILURE > **WORKER\_RECOGNIZER\_CREATION\_FAILURE**: `"WORKER_RECOGNIZER_CREATION_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:16](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L16) ##### WORKER\_RUNNER\_EXISTS > **WORKER\_RUNNER\_EXISTS**: `"WORKER_RUNNER_EXISTS"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:17](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L17) ##### WORKER\_RUNNER\_CREATION\_FAILURE > **WORKER\_RUNNER\_CREATION\_FAILURE**: `"WORKER_RUNNER_CREATION_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:18](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L18) ##### WORKER\_RUNNER\_MISSING > **WORKER\_RUNNER\_MISSING**: `"WORKER_RUNNER_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:19](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L19) ##### WORKER\_RUNNER\_RECONFIGURE\_FAILURE > **WORKER\_RUNNER\_RECONFIGURE\_FAILURE**: `"WORKER_RUNNER_RECONFIGURE_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:20](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L20) ##### WORKER\_RUNNER\_DELETED > **WORKER\_RUNNER\_DELETED**: `"WORKER_RUNNER_DELETED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:21](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L21) ##### WORKER\_RUNNER\_DELETE\_FAILURE > **WORKER\_RUNNER\_DELETE\_FAILURE**: `"WORKER_RUNNER_DELETE_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:22](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L22) ##### WORKER\_OBJECT\_INVOKE\_FAILURE > **WORKER\_OBJECT\_INVOKE\_FAILURE**: `"WORKER_OBJECT_INVOKE_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L23) ##### WORKER\_IMAGE\_PROCESS\_FAILURE > **WORKER\_IMAGE\_PROCESS\_FAILURE**: `"WORKER_IMAGE_PROCESS_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:24](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L24) ##### WORKER\_HANDLE\_UNDEFINED > **WORKER\_HANDLE\_UNDEFINED**: `"WORKER_HANDLE_UNDEFINED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:25](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L25) ##### WORKER\_MESSAGE\_ACTION\_UNKNOWN > **WORKER\_MESSAGE\_ACTION\_UNKNOWN**: `"WORKER_MESSAGE_ACTION_UNKNOWN"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:26](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L26) ##### WORKER\_LICENSE\_UNLOCK\_ERROR > **WORKER\_LICENSE\_UNLOCK\_ERROR**: `"WORKER_LICENSE_UNLOCK_ERROR"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:27](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L27) ##### WORKER\_INTEGRATION\_INFO\_FAILURE > **WORKER\_INTEGRATION\_INFO\_FAILURE**: `"WORKER_INTEGRATION_INFO_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:28](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L28) ##### LOCAL\_SDK\_RUNNER\_MISSING > **LOCAL\_SDK\_RUNNER\_MISSING**: `"LOCAL_SDK_RUNNER_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:30](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L30) ##### LOCAL\_SDK\_RUNNER\_EMPTY > **LOCAL\_SDK\_RUNNER\_EMPTY**: `"LOCAL_SDK_RUNNER_EMPTY"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:31](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L31) ##### LICENSE\_UNLOCK\_ERROR > **LICENSE\_UNLOCK\_ERROR**: `"LICENSE_UNLOCK_ERROR"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:33](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L33) ##### FRAME\_CAPTURE\_SVG\_UNSUPPORTED > **FRAME\_CAPTURE\_SVG\_UNSUPPORTED**: `"FRAME_CAPTURE_SVG_UNSUPPORTED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:35](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L35) ##### FRAME\_CAPTURE\_CANVAS\_MISSING > **FRAME\_CAPTURE\_CANVAS\_MISSING**: `"FRAME_CAPTURE_CANVAS_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:36](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L36) ##### SDK\_WASM\_SETTINGS\_MISSING > **SDK\_WASM\_SETTINGS\_MISSING**: `"SDK_WASM_SETTINGS_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:38](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L38) ##### SDK\_LICENSE\_KEY\_MISSING > **SDK\_LICENSE\_KEY\_MISSING**: `"SDK_LICENSE_KEY_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:39](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L39) ##### SDK\_WASM\_MODULE\_NAME\_MISSING > **SDK\_WASM\_MODULE\_NAME\_MISSING**: `"SDK_WASM_MODULE_NAME_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:40](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L40) ##### SDK\_ENGINE\_LOCATION\_INVALID > **SDK\_ENGINE\_LOCATION\_INVALID**: `"SDK_ENGINE_LOCATION_INVALID"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:41](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L41) ##### SDK\_WORKER\_LOCATION\_INVALID > **SDK\_WORKER\_LOCATION\_INVALID**: `"SDK_WORKER_LOCATION_INVALID"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:42](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L42) ##### SDK\_MISSING > **SDK\_MISSING**: `"SDK_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:43](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L43) ##### SDK\_RECOGNIZERS\_MISSING > **SDK\_RECOGNIZERS\_MISSING**: `"SDK_RECOGNIZERS_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:44](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L44) ##### VIDEO\_RECOGNIZER\_ELEMENT\_MISSING > **VIDEO\_RECOGNIZER\_ELEMENT\_MISSING**: `"VIDEO_RECOGNIZER_ELEMENT_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:46](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L46) ##### VIDEO\_RECOGNIZER\_CAMERA\_MISSING > **VIDEO\_RECOGNIZER\_CAMERA\_MISSING**: `"VIDEO_RECOGNIZER_CAMERA_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:47](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L47) ##### VIDEO\_RECOGNIZER\_CAMERA\_NOT\_ALLOWED > **VIDEO\_RECOGNIZER\_CAMERA\_NOT\_ALLOWED**: `"VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:48](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L48) ##### VIDEO\_RECOGNIZER\_CAMERA\_UNAVAILABLE > **VIDEO\_RECOGNIZER\_CAMERA\_UNAVAILABLE**: `"VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:49](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L49) ##### VIDEO\_RECOGNIZER\_CAMERA\_IN\_USE > **VIDEO\_RECOGNIZER\_CAMERA\_IN\_USE**: `"VIDEO_RECOGNIZER_CAMERA_IN_USE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:50](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L50) ##### VIDEO\_RECOGNIZER\_MEDIA\_DEVICES\_UNSUPPORTED > **VIDEO\_RECOGNIZER\_MEDIA\_DEVICES\_UNSUPPORTED**: `"VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:51](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L51) ##### VIDEO\_RECOGNIZER\_FEED\_RELEASED > **VIDEO\_RECOGNIZER\_FEED\_RELEASED**: `"VIDEO_RECOGNIZER_FEED_RELEASED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L52) ##### VIDEO\_RECOGNIZER\_FEED\_NOT\_PAUSED > **VIDEO\_RECOGNIZER\_FEED\_NOT\_PAUSED**: `"VIDEO_RECOGNIZER_FEED_NOT_PAUSED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:53](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L53) ##### VIDEO\_RECOGNIZER\_PLAY\_REQUEST\_INTERRUPTED > **VIDEO\_RECOGNIZER\_PLAY\_REQUEST\_INTERRUPTED**: `"VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:54](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L54) ##### VIDEO\_RECOGNIZER\_FEED\_PAUSED > **VIDEO\_RECOGNIZER\_FEED\_PAUSED**: `"VIDEO_RECOGNIZER_FEED_PAUSED"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:55](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L55) ##### VIDEO\_RECOGNIZER\_RECOGNIZERS\_RESET\_FAILURE > **VIDEO\_RECOGNIZER\_RECOGNIZERS\_RESET\_FAILURE**: `"VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:56](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L56) ##### VIDEO\_RECOGNIZER\_FEED\_MISSING > **VIDEO\_RECOGNIZER\_FEED\_MISSING**: `"VIDEO_RECOGNIZER_FEED_MISSING"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:57](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L57) *** ### ErrorMessages Defined in: [src/MicroblinkSDK/ErrorTypes.ts:60](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L60) #### Enumeration Members ##### WORKER\_HANDLE\_UNDEFINED > **WORKER\_HANDLE\_UNDEFINED**: `"Cannot find object with handle: undefined"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:61](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L61) ##### WORKER\_WASM\_LOAD\_FAILURE > **WORKER\_WASM\_LOAD\_FAILURE**: `"Failed to load WASM in web worker!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:62](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L62) ##### WORKER\_WASM\_INIT\_MISSING > **WORKER\_WASM\_INIT\_MISSING**: `"WASM module is not initialized!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:63](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L63) ##### WORKER\_FUNCTION\_INVOKE\_FAILURE > **WORKER\_FUNCTION\_INVOKE\_FAILURE**: `"Failed to invoke function!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:64](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L64) ##### WORKER\_RECOGNIZER\_CREATION\_FAILURE > **WORKER\_RECOGNIZER\_CREATION\_FAILURE**: `"Failed to create new recognizer!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L65) ##### WORKER\_RUNNER\_EXISTS > **WORKER\_RUNNER\_EXISTS**: `"Recognizer runner is already created! Multiple instances are not allowed!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:66](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L66) ##### WORKER\_RUNNER\_CREATION\_FAILURE > **WORKER\_RUNNER\_CREATION\_FAILURE**: `"Failed to create new recognizer runner!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:67](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L67) ##### WORKER\_RUNNER\_MISSING > **WORKER\_RUNNER\_MISSING**: `"Recognizer runner is not created! There is nothing to reconfigure!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:68](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L68) ##### WORKER\_RUNNER\_RECONFIGURE\_FAILURE > **WORKER\_RUNNER\_RECONFIGURE\_FAILURE**: `"Failed to reconfigure recognizer runner!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:69](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L69) ##### WORKER\_RUNNER\_DELETED > **WORKER\_RUNNER\_DELETED**: `"Recognizer runner is already deleted!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:70](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L70) ##### WORKER\_RUNNER\_DELETE\_FAILURE > **WORKER\_RUNNER\_DELETE\_FAILURE**: `"Failed to delete recognizer runner!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:71](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L71) ##### WORKER\_OBJECT\_INVOKE\_FAILURE > **WORKER\_OBJECT\_INVOKE\_FAILURE**: `"Failed to invoke object!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:72](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L72) ##### WORKER\_IMAGE\_PROCESS\_FAILURE > **WORKER\_IMAGE\_PROCESS\_FAILURE**: `"Recognizer runner is not initialized! Cannot process image!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:73](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L73) ##### WORKER\_INTEGRATION\_INFO\_FAILURE > **WORKER\_INTEGRATION\_INFO\_FAILURE**: `"Failed to get product integration info!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:74](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L74) ##### LOCAL\_SDK\_RUNNER\_MISSING > **LOCAL\_SDK\_RUNNER\_MISSING**: `"Property nativeRecognizerRunner is not available!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:76](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L76) ##### LOCAL\_SDK\_RUNNER\_EMPTY > **LOCAL\_SDK\_RUNNER\_EMPTY**: `"Native RecognizerRunner cannot be empty!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:77](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L77) ##### LICENSE\_TOKEN\_STATE\_INCORRECT > **LICENSE\_TOKEN\_STATE\_INCORRECT**: `"Internal error (Incorrect token state)"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:79](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L79) ##### LICENSE\_PAYLOAD\_VERIFICATION\_FAILED > **LICENSE\_PAYLOAD\_VERIFICATION\_FAILED**: `"Failed to verify server permission's digital signature!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:80](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L80) ##### LICENSE\_PAYLOAD\_CORRUPTED > **LICENSE\_PAYLOAD\_CORRUPTED**: `"Server permission payload is corrupted!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L81) ##### LICENSE\_PERMISSION\_EXPIRED > **LICENSE\_PERMISSION\_EXPIRED**: `"Internal error (server permission expired)"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:82](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L82) ##### LICENSE\_REMOTE\_LOCKED > **LICENSE\_REMOTE\_LOCKED**: `"Provided license key has been remotely locked. Please contact support for more information!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:83](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L83) ##### FRAME\_CAPTURE\_SVG\_UNSUPPORTED > **FRAME\_CAPTURE\_SVG\_UNSUPPORTED**: `"Recognition of SVG elements not supported!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:85](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L85) ##### FRAME\_CAPTURE\_CANVAS\_MISSING > **FRAME\_CAPTURE\_CANVAS\_MISSING**: `"Could not get canvas 2d context!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:86](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L86) ##### SDK\_WASM\_SETTINGS\_MISSING > **SDK\_WASM\_SETTINGS\_MISSING**: `"Missing WASM load settings!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:88](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L88) ##### SDK\_LICENSE\_KEY\_MISSING > **SDK\_LICENSE\_KEY\_MISSING**: `"Missing license key!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:89](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L89) ##### SDK\_WASM\_MODULE\_NAME\_MISSING > **SDK\_WASM\_MODULE\_NAME\_MISSING**: `"Missing WASM module name!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L90) ##### SDK\_ENGINE\_LOCATION\_INVALID > **SDK\_ENGINE\_LOCATION\_INVALID**: `"Setting property 'engineLocation' must be a string!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:91](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L91) ##### SDK\_WORKER\_LOCATION\_INVALID > **SDK\_WORKER\_LOCATION\_INVALID**: `"Setting property 'workerLocation' must be a string!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:92](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L92) ##### SDK\_MISSING > **SDK\_MISSING**: `"SDK is not provided!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:93](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L93) ##### SDK\_RECOGNIZERS\_MISSING > **SDK\_RECOGNIZERS\_MISSING**: `"To create RecognizerRunner at least 1 recognizer is required."` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:94](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L94) ##### VIDEO\_RECOGNIZER\_ELEMENT\_MISSING > **VIDEO\_RECOGNIZER\_ELEMENT\_MISSING**: `"Video element, i.e. camera feed is not provided!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:96](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L96) ##### VIDEO\_RECOGNIZER\_CAMERA\_MISSING > **VIDEO\_RECOGNIZER\_CAMERA\_MISSING**: `"Camera not found!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:97](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L97) ##### VIDEO\_RECOGNIZER\_CAMERA\_NOT\_ALLOWED > **VIDEO\_RECOGNIZER\_CAMERA\_NOT\_ALLOWED**: `"Camera not allowed!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:98](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L98) ##### VIDEO\_RECOGNIZER\_CAMERA\_UNAVAILABLE > **VIDEO\_RECOGNIZER\_CAMERA\_UNAVAILABLE**: `"Camera not available!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:99](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L99) ##### VIDEO\_RECOGNIZER\_CAMERA\_IN\_USE > **VIDEO\_RECOGNIZER\_CAMERA\_IN\_USE**: `"Camera in use!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:100](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L100) ##### VIDEO\_RECOGNIZER\_MEDIA\_DEVICES\_UNSUPPORTED > **VIDEO\_RECOGNIZER\_MEDIA\_DEVICES\_UNSUPPORTED**: `"Media devices not supported by browser."` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:101](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L101) ##### VIDEO\_RECOGNIZER\_FEED\_RELEASED > **VIDEO\_RECOGNIZER\_FEED\_RELEASED**: `"The associated video feed has been released!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:102](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L102) ##### VIDEO\_RECOGNIZER\_FEED\_NOT\_PAUSED > **VIDEO\_RECOGNIZER\_FEED\_NOT\_PAUSED**: `"The associated video feed is not paused. Use resumeRecognition instead!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:103](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L103) ##### VIDEO\_RECOGNIZER\_PLAY\_REQUEST\_INTERRUPTED > **VIDEO\_RECOGNIZER\_PLAY\_REQUEST\_INTERRUPTED**: `"The play() request was interrupted or prevented by browser security rules!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:104](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L104) ##### VIDEO\_RECOGNIZER\_FEED\_PAUSED > **VIDEO\_RECOGNIZER\_FEED\_PAUSED**: `"Cannot resume recognition while video feed is paused! Use recognize or startRecognition"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:105](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L105) ##### VIDEO\_RECOGNIZER\_RECOGNIZERS\_RESET\_FAILURE > **VIDEO\_RECOGNIZER\_RECOGNIZERS\_RESET\_FAILURE**: `"Could not reset recognizers!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:106](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L106) ##### VIDEO\_RECOGNIZER\_FEED\_MISSING > **VIDEO\_RECOGNIZER\_FEED\_MISSING**: `"Missing video feed!"` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:107](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L107) *** ### LicenseTokenState Defined in: [src/MicroblinkSDK/License.ts:8](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L8) #### Enumeration Members ##### Invalid > **Invalid**: `0` Defined in: [src/MicroblinkSDK/License.ts:10](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L10) ##### RequiresServerPermission > **RequiresServerPermission**: `1` Defined in: [src/MicroblinkSDK/License.ts:11](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L11) ##### Valid > **Valid**: `2` Defined in: [src/MicroblinkSDK/License.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L12) *** ### LicenseErrorType Defined in: [src/MicroblinkSDK/License.ts:31](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L31) #### Enumeration Members ##### LicenseTokenStateInvalid {/* #licensetokenstateinvalid-1 */} > **LicenseTokenStateInvalid**: `"LICENSE_TOKEN_STATE_INVALID"` Defined in: [src/MicroblinkSDK/License.ts:32](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L32) ##### NetworkError > **NetworkError**: `"NETWORK_ERROR"` Defined in: [src/MicroblinkSDK/License.ts:33](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L33) ##### RemoteLock > **RemoteLock**: `"REMOTE_LOCK"` Defined in: [src/MicroblinkSDK/License.ts:34](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L34) ##### PermissionExpired > **PermissionExpired**: `"PERMISSION_EXPIRED"` Defined in: [src/MicroblinkSDK/License.ts:35](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L35) ##### PayloadCorrupted > **PayloadCorrupted**: `"PAYLOAD_CORRUPTED"` Defined in: [src/MicroblinkSDK/License.ts:36](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L36) ##### PayloadSignatureVerificationFailed > **PayloadSignatureVerificationFailed**: `"PAYLOAD_SIGNATURE_VERIFICATION_FAILED"` Defined in: [src/MicroblinkSDK/License.ts:37](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L37) ##### IncorrectTokenState > **IncorrectTokenState**: `"INCORRECT_TOKEN_STATE"` Defined in: [src/MicroblinkSDK/License.ts:38](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L38) *** ### ServerPermissionSubmitResultStatus Defined in: [src/MicroblinkSDK/License.ts:86](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L86) #### Enumeration Members ##### Ok > **Ok**: `0` Defined in: [src/MicroblinkSDK/License.ts:88](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L88) ##### NetworkError > **NetworkError**: `1` Defined in: [src/MicroblinkSDK/License.ts:89](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L89) ##### RemoteLock > **RemoteLock**: `2` Defined in: [src/MicroblinkSDK/License.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L90) ##### PermissionExpired > **PermissionExpired**: `3` Defined in: [src/MicroblinkSDK/License.ts:91](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L91) ##### PayloadCorrupted > **PayloadCorrupted**: `4` Defined in: [src/MicroblinkSDK/License.ts:92](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L92) ##### PayloadSignatureVerificationFailed > **PayloadSignatureVerificationFailed**: `5` Defined in: [src/MicroblinkSDK/License.ts:93](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L93) ##### IncorrectTokenState > **IncorrectTokenState**: `6` Defined in: [src/MicroblinkSDK/License.ts:94](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L94) *** ### DetectionStatus Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L52) Detection status of the specific detected object. #### Enumeration Members ##### Failed > **Failed**: `0` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:55](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L55) Detection has failed. ##### Success > **Success**: `1` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:57](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L57) Document has been detected. ##### CameraTooFar > **CameraTooFar**: `2` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:59](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L59) Document has been detected but the camera is too far from the document. ##### CameraTooClose > **CameraTooClose**: `3` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:61](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L61) Document has been detected but the camera is too close to the document. ##### CameraAngleTooSteep > **CameraAngleTooSteep**: `4` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:63](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L63) Document has been detected but the camera’s angle is too steep. ##### DocumentTooCloseToCameraEdge > **DocumentTooCloseToCameraEdge**: `5` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L65) Document has been detected but the document is too close to the camera edge. ##### DocumentPartiallyVisible > **DocumentPartiallyVisible**: `6` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:67](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L67) Only part of the document is visible. ##### FallbackSuccess > **FallbackSuccess**: `7` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:69](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L69) Fallback detection was successful (PhotoPay specific). *** ### VideoRecognitionMode Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:36](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L36) Indicates mode of recognition in `VideoRecognizer`. #### Enumeration Members ##### Recognition > **Recognition**: `0` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:38](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L38) Normal recognition ##### RecognitionTest > **RecognitionTest**: `1` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:40](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L40) Indefinite scan. Useful for profiling the performance of scan (using `onDebugText` metadata callback) ##### DetectionTest > **DetectionTest**: `2` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:42](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L42) Only detection. Useful for profiling the performance of detection (using `onDebugText` metadata callback) *** ### WasmType {/* #wasmtype-1 */} Defined in: [src/MicroblinkSDK/WasmType.ts:8](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmType.ts#L8) Defines the type of the WASM that will be loaded. #### Enumeration Members ##### Basic > **Basic**: `"BASIC"` Defined in: [src/MicroblinkSDK/WasmType.ts:14](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmType.ts#L14) The WASM that will be loaded will be most compatible with all browsers that support the WASM, but will lack features that could be used to improve performance. ##### Advanced > **Advanced**: `"ADVANCED"` Defined in: [src/MicroblinkSDK/WasmType.ts:22](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmType.ts#L22) The WASM that will be loaded will be built with advanced WASM features, such as bulk memory, SIMD, non-trapping floating point and sign extension. Such WASM can only be executed in browsers that support those features. Attempting to run this WASM in a non-compatible browser will crash your app. ##### AdvancedWithThreads > **AdvancedWithThreads**: `"ADVANCED_WITH_THREADS"` Defined in: [src/MicroblinkSDK/WasmType.ts:30](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmType.ts#L30) The WASM that will be loaded will be build with advanced WASM features, just like above. Additionally, it will be also built with support for multi-threaded processing. This feature requires a browser with support for both advanced WASM features and `SharedArrayBuffer` *** ### LivenessStatus Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:24](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L24) #### Enumeration Members ##### NotAvailable > **NotAvailable**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:28](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L28) Verification process has not been started yet ##### HandNotPresent > **HandNotPresent**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:32](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L32) Hand not present ##### NotEnoughHandPresent > **NotEnoughHandPresent**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:36](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L36) Not enough hand present ##### DocumentNotInHand > **DocumentNotInHand**: `3` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:40](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L40) Detected document not in hand ##### DocumentInHand > **DocumentInHand**: `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:44](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L44) Detected document in hand *** ### CheckResult Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:49](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L49) #### Enumeration Members ##### NotPerformed > **NotPerformed**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:50](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L50) ##### Pass > **Pass**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:51](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L51) ##### Fail > **Fail**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L52) *** ### MatchLevel Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:55](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L55) #### Enumeration Members ##### Disabled > **Disabled**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:56](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L56) ##### Level1 > **Level1**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:57](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L57) ##### Level2 > **Level2**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:58](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L58) ##### Level3 > **Level3**: `3` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:59](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L59) ##### Level4 > **Level4**: `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:60](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L60) ##### Level5 > **Level5**: `5` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:61](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L61) ##### Level6 > **Level6**: `6` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:62](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L62) ##### Level7 > **Level7**: `7` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:63](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L63) ##### Level8 > **Level8**: `8` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:64](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L64) ##### Level9 > **Level9**: `9` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L65) ##### Level10 > **Level10**: `10` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:66](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L66) *** ### AnonymizationMode Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:88](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L88) Determines which data is anonymized in the returned recognizer result #### Enumeration Members ##### None > **None**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:91](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L91) No anonymization is performed in this mode. ##### ImageOnly > **ImageOnly**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:97](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L97) Sensitive data in the document image is anonymized with black boxes covering selected sensitive data. Data returned in result fields is not changed. ##### ResultFieldsOnly > **ResultFieldsOnly**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:100](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L100) Document image is not changed. Data returned in result fields is redacted. ##### FullResult > **FullResult**: `3` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:106](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L106) Sensitive data in the image is anonymized with black boxes covering selected sensitive data. Data returned in result fields is redacted. ##### Count > **Count**: `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:109](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L109) Number of possible anonymization modes. *** ### CardIssuer Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:369](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L369) Payment Card Issuer defines supported issuing institutions that issued the card to the card holder. #### Enumeration Members ##### Other > **Other**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:372](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L372) ##### AmericanExpress > **AmericanExpress**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:375](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L375) ##### ChinaUnionPay > **ChinaUnionPay**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:378](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L378) ##### Diners > **Diners**: `3` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:381](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L381) ##### DiscoverCard > **DiscoverCard**: `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:384](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L384) ##### Elo > **Elo**: `5` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:387](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L387) ##### Jcb > **Jcb**: `6` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:390](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L390) ##### Maestro > **Maestro**: `7` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:393](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L393) ##### Mastercard > **Mastercard**: `8` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:396](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L396) ##### RuPay > **RuPay**: `9` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:399](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L399) ##### Verve > **Verve**: `10` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:402](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L402) ##### Visa > **Visa**: `11` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:405](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L405) ##### VPay > **VPay**: `12` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:408](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L408) ##### Count > **Count**: `13` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:411](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L411) *** ### ProcessingStatus {/* #processingstatus-1 */} Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:417](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L417) Detailed information about the recognition process. #### Enumeration Members ##### Success > **Success**: `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:420](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L420) Recognition was successful. ##### DetectionFailed > **DetectionFailed**: `1` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:423](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L423) Detection of the document failed. ##### ImagePreprocessingFailed > **ImagePreprocessingFailed**: `2` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:426](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L426) Preprocessing of the input image has failed. ##### StabilityTestFailed > **StabilityTestFailed**: `3` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:429](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L429) Recognizer has inconsistent results. ##### ScanningWrongSide > **ScanningWrongSide**: `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:432](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L432) Wrong side of the document has been scanned. ##### FieldIdentificationFailed > **FieldIdentificationFailed**: `5` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:435](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L435) Identification of the fields present on the card has failed. ##### ImageReturnFailed > **ImageReturnFailed**: `6` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:438](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L438) Failed to return a requested image. ##### UnsupportedCard > **UnsupportedCard**: `7` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:441](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L441) Payment card currently not supported by the recognizer. ##### Count > **Count**: `8` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:444](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L444) Number of possible processing statuses. ## Classes ### SelectedCamera Defined in: [src/MicroblinkSDK/CameraUtils.ts:171](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L171) #### Constructors ##### Constructor > **new SelectedCamera**(`mdi`, `facing`, `label?`): [`SelectedCamera`](#selectedcamera) Defined in: [src/MicroblinkSDK/CameraUtils.ts:181](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L181) ###### Parameters ###### mdi `MediaDeviceInfo` ###### facing {/* #facing-1 */} [`PreferredCameraType`](#preferredcameratype) ###### label? {/* #label-1 */} `string` ###### Returns [`SelectedCamera`](#selectedcamera) #### Properties ##### deviceId > `readonly` **deviceId**: `string` Defined in: [src/MicroblinkSDK/CameraUtils.ts:173](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L173) ##### groupId > `readonly` **groupId**: `string` Defined in: [src/MicroblinkSDK/CameraUtils.ts:175](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L175) ##### facing {/* #facing */} > `readonly` **facing**: [`PreferredCameraType`](#preferredcameratype) Defined in: [src/MicroblinkSDK/CameraUtils.ts:177](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L177) ##### label {/* #label */} > `readonly` **label**: `string` Defined in: [src/MicroblinkSDK/CameraUtils.ts:179](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L179) *** ### CapturedFrame Defined in: [src/MicroblinkSDK/FrameCapture.ts:20](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L20) Represents a captured frame from HTMLVideoElement. #### Constructors ##### Constructor > **new CapturedFrame**(`imageData`, `orientation`, `videoFrame`): [`CapturedFrame`](#capturedframe) Defined in: [src/MicroblinkSDK/FrameCapture.ts:31](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L31) ###### Parameters ###### imageData {/* #imagedata-1 */} `ImageData` ###### orientation {/* #orientation-1 */} [`ImageOrientation`](#imageorientation) ###### videoFrame {/* #videoframe-1 */} `boolean` ###### Returns [`CapturedFrame`](#capturedframe) #### Properties ##### imageData {/* #imagedata */} > `readonly` **imageData**: `ImageData` Defined in: [src/MicroblinkSDK/FrameCapture.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L23) Instance of ImageData object - contains pixels and metadata about the captured image. ##### orientation {/* #orientation */} > `readonly` **orientation**: [`ImageOrientation`](#imageorientation) Defined in: [src/MicroblinkSDK/FrameCapture.ts:26](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L26) Orientation of the captured frame ##### videoFrame {/* #videoframe */} > `readonly` **videoFrame**: `boolean` Defined in: [src/MicroblinkSDK/FrameCapture.ts:29](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L29) Indicates whether captured frame originated from still image or video stream. *** ### SDKError Defined in: [src/MicroblinkSDK/SDKError.ts:8](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L8) Copyright (c) Microblink Ltd. All rights reserved. #### Extends - `Error` #### Constructors ##### Constructor > **new SDKError**(`error`, `details?`): [`SDKError`](#sdkerror) Defined in: [src/MicroblinkSDK/SDKError.ts:16](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L16) ###### Parameters ###### error {/* #error-1 */} \{ `code`: `string`; `message`: `string`; \} | [`SerializableSDKError`](#serializablesdkerror) ###### details? {/* #details-2 */} `any` ###### Returns [`SDKError`](#sdkerror) ###### Overrides `Error.constructor` #### Properties ##### code > **code**: `string` Defined in: [src/MicroblinkSDK/SDKError.ts:10](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L10) ##### message > **message**: `string` Defined in: [src/MicroblinkSDK/SDKError.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L12) ###### Overrides `Error.message` ##### details? {/* #details */} > `optional` **details**: `any` Defined in: [src/MicroblinkSDK/SDKError.ts:14](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L14) *** ### SerializableSDKError Defined in: [src/MicroblinkSDK/SDKError.ts:48](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L48) #### Constructors ##### Constructor > **new SerializableSDKError**(`error`, `details?`): [`SerializableSDKError`](#serializablesdkerror) Defined in: [src/MicroblinkSDK/SDKError.ts:56](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L56) ###### Parameters ###### error {/* #error-2 */} ###### code {/* #code-2 */} `string` ###### message {/* #message-2 */} `string` ###### details? {/* #details-3 */} `any` ###### Returns [`SerializableSDKError`](#serializablesdkerror) #### Properties ##### code {/* #code-1 */} > **code**: `string` Defined in: [src/MicroblinkSDK/SDKError.ts:50](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L50) ##### message {/* #message-1 */} > **message**: `string` Defined in: [src/MicroblinkSDK/SDKError.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L52) ##### details? {/* #details-1 */} > `optional` **details**: `any` Defined in: [src/MicroblinkSDK/SDKError.ts:54](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/SDKError.ts#L54) *** ### VideoRecognizer Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:59](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L59) A wrapper around `RecognizerRunner` that can use it to perform recognition of video feeds - either from live camera or from predefined video file. #### Constructors ##### Constructor > **new VideoRecognizer**(`videoElement`, `recognizerRunner`, `cameraFlipped`, `deviceId`): [`VideoRecognizer`](#videorecognizer) Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:114](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L114) **Use only if provided factory functions are not well-suited for your use case.** Creates a new `VideoRecognizer` with provided `HTMLVideoElement`. Keep in mind that `HTMLVideoElement` **must have** a video feed which is ready to use. - If you want to take advantage of provided camera management, use `createVideoRecognizerFromCameraStream` - In case that static video file should be processed, use `createVideoRecognizerFromVideoPath` ###### Parameters ###### videoElement `HTMLVideoElement` HTMLVideoElement with video feed which is going to be processed ###### recognizerRunner {/* #recognizerrunner-1 */} [`RecognizerRunner`](#recognizerrunner) RecognizerRunner that should be used for video stream recognition ###### cameraFlipped `boolean` = `false` Whether the camera is flipped, e.g. if front-facing camera is used ###### deviceId {/* #deviceid-2 */} `string` | `null` ###### Returns [`VideoRecognizer`](#videorecognizer) #### Properties ##### deviceId {/* #deviceid-1 */} > **deviceId**: `string` \| `null` = `null` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L65) #### Methods ##### createVideoRecognizerFromCameraStream() > `static` **createVideoRecognizerFromCameraStream**(`cameraFeed`, `recognizerRunner`, `cameraId`, `preferredCameraType`): `Promise`\<[`VideoRecognizer`](#videorecognizer)\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:171](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L171) Creates a new VideoRecognizer by opening a camera stream and attaching it to given `HTMLVideoElement`. If camera cannot be accessed, the returned promise will be rejected. ###### Parameters ###### cameraFeed `HTMLVideoElement` `HTMLVideoElement` to which camera stream should be attached ###### recognizerRunner {/* #recognizerrunner-2 */} [`RecognizerRunner`](#recognizerrunner) `RecognizerRunner` that should be used for video stream recognition ###### cameraId User can provide specific camera ID to be selected and used `string` | `null` ###### preferredCameraType [`PreferredCameraType`](#preferredcameratype) = `PreferredCameraType.BackFacingCamera` Whether back facing or front facing camera is preferred. Obeyed only if there is a choice (i.e. if device has only front-facing camera, the opened camera will be a front-facing camera, regardless of preference) ###### Returns `Promise`\<[`VideoRecognizer`](#videorecognizer)\> ##### createVideoRecognizerFromVideoPath() > `static` **createVideoRecognizerFromVideoPath**(`videoPath`, `videoElement`, `recognizerRunner`): [`VideoRecognizer`](#videorecognizer) Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:224](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L224) Creates a new `VideoRecognizer` by attaching the given URL to video to given `HTMLVideoElement` and using it to display video frames while processing them. ###### Parameters ###### videoPath `string` URL of the video file that should be recognized. ###### videoElement `HTMLVideoElement` `HTMLVideoElement` to which video file will be attached ###### recognizerRunner {/* #recognizerrunner-3 */} [`RecognizerRunner`](#recognizerrunner) `RecognizerRunner` that should be used for video stream recognition. ###### Returns [`VideoRecognizer`](#videorecognizer) ##### setOnFrameProcessed() > **setOnFrameProcessed**(`onFrameProcessed`): `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:249](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L249) Sets the callback that will be invoked when frame is processed ###### Parameters ###### onFrameProcessed {/* #onframeprocessed-1 */} Callback that will be invoked when frame is processed [`OnFrameProcessed`](#onframeprocessed) | `null` ###### Returns `void` ##### flipCamera() > **flipCamera**(): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:254](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L254) ###### Returns `Promise`\<`void`\> ##### isCameraFlipped() > **isCameraFlipped**(): `boolean` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:261](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L261) ###### Returns `boolean` ##### setVideoRecognitionMode() > **setVideoRecognitionMode**(`videoRecognitionMode`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:269](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L269) Sets the video recognition mode to be used. ###### Parameters ###### videoRecognitionMode [`VideoRecognitionMode`](#videorecognitionmode) ###### Returns `Promise`\<`void`\> ##### startRecognition() > **startRecognition**(`onScanningDone`, `recognitionTimeoutMs`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:302](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L302) Starts the recognition of the video stream associated with this `VideoRecognizer`. The stream will be unpaused and recognition loop will start. After recognition completes, an `onScanningDone` callback will be invoked with state of the recognition. NOTE: As soon as the execution of the callback completes, the recognition loop will continue and recognition state will be retained. To clear the recognition state, use [`resetRecognizers`](#resetrecognizers-2) (within your callback). To pause the recognition loop, use [`pauseRecognition`](#pauserecognition) (within your callback) - to resume it later use [`resumeRecognition`](#resumerecognition). To completely stop the recognition and video feed, while keeping the ability to use this `VideoRecognizer` later, use [`pauseVideoFeed`](#pausevideofeed). To completely stop the recognition and video feed and release all the resources involved with the video stream, use [`releaseVideoFeed`](#releasevideofeed). ###### Parameters ###### onScanningDone {/* #onscanningdone-1 */} [`OnScanningDone`](#onscanningdone) Callback that will be invoked when recognition completes. ###### recognitionTimeoutMs `number` = `20000` Amount of time in ms that the recognizer will stay in the `Uncertain` state before resolving. ###### Returns `Promise`\<`void`\> ##### resumeRecognition() > **resumeRecognition**(`resetRecognizers`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:334](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L334) Resumes the recognition and video playback ###### Parameters ###### resetRecognizers {/* #resetrecognizers-1 */} `boolean` Indicates whether resetRecognizers should be invoked while resuming the recognition ###### Returns `Promise`\<`void`\> ##### recognize() > **recognize**(`recognitionTimeoutMs`): `Promise`\<[`RecognizerResultState`](#recognizerresultstate)\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:387](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L387) Performs the recognition of the video stream associated with this `VideoRecognizer`. The stream will be unpaused, recognition will be performed and promise will be resolved with recognition status. After the resolution of returned promise, the video stream will be paused, but not released. To release the stream, use function `releaseVideoFeed`. This is a simple version of [`startRecognition`](#startrecognition) that should be used for most cases, like when you only need to perform one scan per video session. ###### Parameters ###### recognitionTimeoutMs `number` = `20000` Amount of time in ms that the recognizer will stay in the `Uncertain` state before resolving. ###### Returns `Promise`\<[`RecognizerResultState`](#recognizerresultstate)\> ##### pauseVideoFeed() > **pauseVideoFeed**(): `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:407](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L407) Pauses the video feed. You can resume the feed by calling recognize or `startRecognition`. Note that this pauses both the camera feed and recognition. If you just want to pause recognition, while keeping the camera feed active, call method `pauseRecognition`. ###### Returns `void` ##### pauseRecognition() > **pauseRecognition**(): `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:426](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L426) Pauses the recognition. This means that video frames that arrive from given video source will not be recognized. To resume recognition, call [`resumeRecognition`](#resumerecognition). ###### Returns `void` ##### cancelRecognition() > **cancelRecognition**(): `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:434](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L434) Cancels current ongoing recognition. Unlike [`pauseRecognition`](#pauserecognition) this will reset everything ###### Returns `void` ##### resetRecognizers() {/* #resetrecognizers-2 */} > **resetRecognizers**(`hardReset`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:444](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L444) Convenience method for invoking [`RecognizerRunner.resetRecognizers`](#resetrecognizers) on associated `RecognizerRunner`. ###### Parameters ###### hardReset `boolean` ###### Returns `Promise`\<`void`\> ##### getRecognizerRunner() > **getRecognizerRunner**(): [`RecognizerRunner`](#recognizerrunner) Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:455](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L455) Convenience method for accessing `RecognizerRunner` associated with this `VideoRecognizer`. Sometimes it's useful to reconfigure `RecognizerRunner` while handling `onScanningDone` callback and this method makes that much more convenient. ###### Returns [`RecognizerRunner`](#recognizerrunner) ##### getVideoElement() > **getVideoElement**(): `HTMLVideoElement` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:463](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L463) Getter for `videoElement` ###### Returns `HTMLVideoElement` ##### changeCameraDevice() > **changeCameraDevice**(`camera`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:476](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L476) Change currently used camera device for recognition. To get list of available camera devices use `getCameraDevices` method. Keep in mind that this method will reset recognizers. ###### Parameters ###### camera [`SelectedCamera`](#selectedcamera) Desired camera device which should be used for recognition. ###### Returns `Promise`\<`void`\> ##### releaseVideoFeed() > **releaseVideoFeed**(): `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:648](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L648) Stops all media stream tracks associated with `videoElement`. ###### Returns `void` *** ### WasmSDKLoadSettings Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L23) Settings object for function loadWasmModule. #### Constructors ##### Constructor > **new WasmSDKLoadSettings**(`licenseKey`): [`WasmSDKLoadSettings`](#wasmsdkloadsettings) Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:108](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L108) ###### Parameters ###### licenseKey {/* #licensekey-1 */} `string` License key for unlocking the WebAssembly module. ###### Returns [`WasmSDKLoadSettings`](#wasmsdkloadsettings) #### Properties ##### licenseKey {/* #licensekey */} > **licenseKey**: `string` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:28](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L28) License key for unlocking the WebAssembly module. Bound to the domain name from which the application is served. ##### allowHelloMessage > **allowHelloMessage**: `boolean` = `true` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:38](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L38) Write a hello message to the browser console when license check is successfully performed. Hello message will contain the name and version of the SDK, which are required information for all support tickets. The default value is true. ##### engineLocation > **engineLocation**: `string` = `""` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L52) Absolute location of WASM and related JS/data files. Useful when resource files should be loaded over CDN, or when web frameworks/libraries are used which store resources in specific locations, e.g. inside "assets" folder. Important: if the engine is hosted on another origin, CORS must be enabled between two hosts. That is, server where engine is hosted must have 'Access-Control-Allow-Origin' header for the location of the web app. Important: SDK and WASM resources must be from the same version of a package. Default value is empty string, i.e. "". In case of empty string, value of "window.location.origin" property is going to be used. ##### workerLocation > **workerLocation**: `string` = `""` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:65](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L65) The absolute location of the Web Worker script file that loads the WebAssembly module. Important: the worker script must be served via HTTPS and must be of the same origin as the initiator. See https://github.com/w3c/ServiceWorker/issues/940 (same applies for Web Workers). Important: SDK, worker script and WebAssembly resources must be from the same version of the package. The default value is an empty string, i.e. "", and in that case, the worker script is loaded from the default location in resources folder. ##### wasmType {/* #wasmtype */} > **wasmType**: [`WasmType`](#wasmtype-1) \| `null` = `null` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:71](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L71) Type of the WASM that will be loaded. By default, if not set, the SDK will automatically determine the best WASM to load. ##### wasmFlavor > **wasmFlavor**: `string` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:78](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L78) Flavor of the WASM that will be loaded. By default, the SDK will automatically determine the best WASM flavor to load. If there are no flavors, use "", i.e. empty string. ##### numberOfWorkers > **numberOfWorkers**: `number` \| `null` = `null` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:87](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L87) Defines the number of workers that will be used for multi-threaded processing of the images. If not set, the number of worker used will match the number of detected CPU cores on a device. If the browser does not support multi-threaded processing or it was deliberately disabled using the `wasmType` property, then this property will be ignored. ##### loadProgressCallback {/* #loadprogresscallback-1 */} > **loadProgressCallback**: [`OptionalLoadProgressCallback`](#optionalloadprogresscallback) = `null` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:96](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L96) Optional callback function that will report the SDK loading progress. This can be useful for displaying progress bar to users with slow connections. The default value is null. ##### wasmModuleName > **wasmModuleName**: `string` = `defaultWasmModuleName` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:103](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L103) Name of the file containing the WebAssembly module. Change this only if you have renamed the original WASM and its support JS file for your purposes. *** ### CardNumberAnonymizationSettings Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:115](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L115) Holds the settings which control card number anonymization. #### Constructors ##### Constructor > **new CardNumberAnonymizationSettings**(): [`CardNumberAnonymizationSettings`](#cardnumberanonymizationsettings) ###### Returns [`CardNumberAnonymizationSettings`](#cardnumberanonymizationsettings) #### Properties ##### mode > **mode**: [`AnonymizationMode`](#anonymizationmode) = `AnonymizationMode.ImageOnly` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:118](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L118) Defines the mode of card number anonymization. ##### prefixDigitsVisible > **prefixDigitsVisible**: `number` = `0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:121](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L121) Defines how many digits at the beginning of the card number remain visible after anonymization. ##### suffixDigitsVisible > **suffixDigitsVisible**: `number` = `4` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:124](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L124) Defines how many digits at the end of the card number remain visible after anonymization. *** ### AnonymizationSettings Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:127](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L127) #### Constructors ##### Constructor > **new AnonymizationSettings**(): [`AnonymizationSettings`](#anonymizationsettings) ###### Returns [`AnonymizationSettings`](#anonymizationsettings) #### Properties ##### cardNumberAnonymizationSettings > **cardNumberAnonymizationSettings**: [`CardNumberAnonymizationSettings`](#cardnumberanonymizationsettings) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:130](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L130) Defines the parameters of card number anonymization. ##### cardNumberPrefixAnonymizationMode > **cardNumberPrefixAnonymizationMode**: [`AnonymizationMode`](#anonymizationmode) = `AnonymizationMode.None` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:133](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L133) Defines the mode of card number prefix anonymization. ##### cvvAnonymizationMode > **cvvAnonymizationMode**: [`AnonymizationMode`](#anonymizationmode) = `AnonymizationMode.None` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:136](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L136) Defines the mode of CVV anonymization. ##### ibanAnonymizationMode > **ibanAnonymizationMode**: [`AnonymizationMode`](#anonymizationmode) = `AnonymizationMode.ImageOnly` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:139](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L139) Defines the mode of IBAN anonymization. ##### ownerAnonymizationMode > **ownerAnonymizationMode**: [`AnonymizationMode`](#anonymizationmode) = `AnonymizationMode.None` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:142](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L142) Defines the mode of owner anonymization. ##### fallbackAnonymization > **fallbackAnonymization**: `boolean` = `false` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:145](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L145) If true, anonymization is applied on all fields of the image if extraction is uncertain. *** ### BlinkCardRecognizerSettings Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:151](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L151) A settings object that is used for configuring the BlinkCardRecognizer. #### Implements - `FullDocumentImageOptions` - [`RecognizerSettings`](#recognizersettings) #### Constructors ##### Constructor > **new BlinkCardRecognizerSettings**(): [`BlinkCardRecognizerSettings`](#blinkcardrecognizersettings) ###### Returns [`BlinkCardRecognizerSettings`](#blinkcardrecognizersettings) #### Properties ##### allowBlurFilter > **allowBlurFilter**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:157](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L157) Whether blured frames filtering is allowed ##### anonymizationSettings > **anonymizationSettings**: [`AnonymizationSettings`](#anonymizationsettings) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:160](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L160) Whether sensitive data should be redacted from the result ##### paddingEdge > **paddingEdge**: `number` = `0.0` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:168](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L168) Padding is a minimum distance from the edge of the frame and is defined as a percentage of the frame width. Default value is 0.0f and in that case padding edge and image edge are the same. If padding edge is needed, recommended value is 0.02f. ##### allowInvalidCardNumber > **allowInvalidCardNumber**: `boolean` = `false` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:173](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L173) Whether invalid card number is accepted ##### tiltDetectionLevel > **tiltDetectionLevel**: [`DetectionLevel`](#detectionlevel) = `DetectionLevel.Mid` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:182](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L182) The level of allowed detected tilt of the document in the image. Defines the severity of allowed detected tilt of the document in the image, as defined in [DetectionLevel](#detectionlevel). Values range from `Off` (detection turned off) to higher levels of allowed tilt. By default, this is set to 'Mid'. ##### extractCvv > **extractCvv**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:187](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L187) Whether to return CVV in recognizer results ##### extractExpiryDate > **extractExpiryDate**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:192](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L192) Whether to return expiry date in recognizer results ##### extractIban > **extractIban**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:197](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L197) Whether to return IBAN in recognizer results ##### extractOwner > **extractOwner**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:202](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L202) Whether to return owner in recognizer results ##### returnFullDocumentImage > **returnFullDocumentImage**: `boolean` = `true` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:205](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L205) If enabled, the result will contain dewarped image of the document. ###### Implementation of `FullDocumentImageOptions.returnFullDocumentImage` ##### returnEncodedFullDocumentImage > **returnEncodedFullDocumentImage**: `boolean` = `false` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:207](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L207) If enabled, the result will contain JPEG-encoded image of the document. ###### Implementation of `FullDocumentImageOptions.returnEncodedFullDocumentImage` ##### handScaleThreshold > **handScaleThreshold**: `number` = `0.15` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:213](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L213) Hand scale is calculated as a ratio between area of hand mask and document mask. `handScaleThreshold` is the minimal value for hand to be accepted as significant. ##### handDocumentOverlapThreshold > **handDocumentOverlapThreshold**: `number` = `0.05` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:221](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L221) This parameter is used to adjust heuristics that eliminate cases when the hand is present in the input but it is not holding the document. `handDocumentOverlapThreshold` is the minimal ratio of hand pixels inside the frame surrounding the document and area of that frame. Only pixels inside that frame are used to ignore false-positive hand segmentations inside the document (e.g. profile photo on documents) ##### screenAnalysisMatchLevel > **screenAnalysisMatchLevel**: [`MatchLevel`](#matchlevel) = `MatchLevel.Level5` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:226](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L226) Screen analysis match level - higher is stricter. ##### photocopyAnalysisMatchLevel > **photocopyAnalysisMatchLevel**: [`MatchLevel`](#matchlevel) = `MatchLevel.Level5` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:231](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L231) Photocopy analysis match level - higher is stricter. ##### documentLivenessCallback {/* #documentlivenesscallback-1 */} > **documentLivenessCallback**: [`DocumentLivenessCallback`](#documentlivenesscallback) \| `null` = `null` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:236](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L236) Called when document verification status is available. ##### fullDocumentImageExtensionFactors > **fullDocumentImageExtensionFactors**: `ExtensionFactors` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:248](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L248) extension factors for full document image. ###### Implementation of `FullDocumentImageOptions.fullDocumentImageExtensionFactors` #### Accessors ##### fullDocumentImageDpi ###### Get Signature > **get** **fullDocumentImageDpi**(): `number` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:240](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L240) The DPI (Dots Per Inch) for full document image in cases when it should be returned. It applies for both encoded and non-encoded versions. ###### Returns `number` ###### Set Signature > **set** **fullDocumentImageDpi**(`value`): `void` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:242](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L242) The DPI (Dots Per Inch) for full document image in cases when it should be returned. It applies for both encoded and non-encoded versions. ###### Parameters ###### value `number` ###### Returns `void` ###### Implementation of `FullDocumentImageOptions.fullDocumentImageDpi` ## Interfaces ### CameraDevices Defined in: [src/MicroblinkSDK/CameraUtils.ts:201](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L201) #### Properties ##### frontCameras > **frontCameras**: [`SelectedCamera`](#selectedcamera)[] Defined in: [src/MicroblinkSDK/CameraUtils.ts:203](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L203) ##### backCameras > **backCameras**: [`SelectedCamera`](#selectedcamera)[] Defined in: [src/MicroblinkSDK/CameraUtils.ts:204](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L204) *** ### WasmNativeObject Defined in: [src/MicroblinkSDK/DataStructures.ts:76](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L76) Specifies an abstract object placed on the WebAssembly heap. Objects placed on the WebAssembly heap are not cleaned up by the garbage collector of the JavaScript engine. The memory used by the object must be cleaned up manually by calling the delete() method. #### Extended by - [`Recognizer`](#recognizer) - [`RecognizerRunner`](#recognizerrunner) #### Methods ##### delete() > **delete**(): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L81) Cleans up the object from the WebAssembly heap. ###### Returns `Promise`\<`void`\> *** ### RecognizerResult Defined in: [src/MicroblinkSDK/DataStructures.ts:87](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L87) Specifies the abstract recognition result. #### Extended by - [`SuccessFrameGrabberRecognizerResult`](#successframegrabberrecognizerresult) - [`BlinkCardRecognizerResult`](#blinkcardrecognizerresult) #### Properties ##### state > `readonly` **state**: [`RecognizerResultState`](#recognizerresultstate) Defined in: [src/MicroblinkSDK/DataStructures.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L90) State of the recognition result. See the documentation for RecognizerResultState for more information. *** ### RecognizerSettings Defined in: [src/MicroblinkSDK/DataStructures.ts:97](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L97) Specifies the abstract settings for the Recognizer object. *** ### Recognizer Defined in: [src/MicroblinkSDK/DataStructures.ts:104](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L104) Specifies an abstract Recognizer object. The Recognizer object is the basic unit of processing. #### Extends - [`WasmNativeObject`](#wasmnativeobject) #### Extended by - [`SuccessFrameGrabberRecognizer`](#successframegrabberrecognizer) - [`BlinkCardRecognizer`](#blinkcardrecognizer) #### Properties ##### recognizerName > `readonly` **recognizerName**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:109](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L109) Name of this recognizer. #### Methods ##### delete() {/* #delete-2 */} > **delete**(): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L81) Cleans up the object from the WebAssembly heap. ###### Returns `Promise`\<`void`\> ###### Inherited from [`WasmNativeObject`](#wasmnativeobject).[`delete`](#delete) ##### currentSettings() > **currentSettings**(): `Promise`\<[`RecognizerSettings`](#recognizersettings)\> Defined in: [src/MicroblinkSDK/DataStructures.ts:114](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L114) Returns the currently applied settings to the specific recognizer. ###### Returns `Promise`\<[`RecognizerSettings`](#recognizersettings)\> ##### updateSettings() > **updateSettings**(`newSettings`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:121](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L121) Applies the new settings to the specific recognizer. Note: if the recognizer is associated with RecognizerRunner, this method will fail. ###### Parameters ###### newSettings [`RecognizerSettings`](#recognizersettings) New settings to be applied to the recognizer. ###### Returns `Promise`\<`void`\> ##### getResult() > **getResult**(): `Promise`\<[`RecognizerResult`](#recognizerresult)\> Defined in: [src/MicroblinkSDK/DataStructures.ts:126](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L126) Returns the current result of the recognition. ###### Returns `Promise`\<[`RecognizerResult`](#recognizerresult)\> ##### toSignedJSON() > **toSignedJSON**(): `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:136](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L136) Returns the JSON representation of the recognizer's result. The JSON will be digitally signed and can be used to verify that the result was provided by the SDK and that it hasn't been manually altered. If the SDK does not have this feature compiled into the WASM, this method will return null. ###### Returns `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> *** ### RecognizerRunner {/* #recognizerrunner */} Defined in: [src/MicroblinkSDK/DataStructures.ts:142](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L142) Specifies a main Recognizer orchestrator object. #### Extends - [`WasmNativeObject`](#wasmnativeobject) #### Properties ##### recognizers > **recognizers**: [`Recognizer`](#recognizer)[] Defined in: [src/MicroblinkSDK/DataStructures.ts:147](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L147) Array of recognizer objects that are currently associated with the RecognizerRunner. #### Methods ##### delete() {/* #delete-4 */} > **delete**(): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L81) Cleans up the object from the WebAssembly heap. ###### Returns `Promise`\<`void`\> ###### Inherited from [`WasmNativeObject`](#wasmnativeobject).[`delete`](#delete) ##### processImage() > **processImage**(`image`): `Promise`\<[`RecognizerResultState`](#recognizerresultstate)\> Defined in: [src/MicroblinkSDK/DataStructures.ts:155](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L155) Starts the recognition of the given image using recognizer objects currently associated with the RecognizerRunner. ###### Parameters ###### image [`CapturedFrame`](#capturedframe) Image to be processed. ###### Returns `Promise`\<[`RecognizerResultState`](#recognizerresultstate)\> Promise that will resolve when image processing finishes. ##### reconfigureRecognizers() > **reconfigureRecognizers**(`recognizers`, `allowMultipleResults`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:165](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L165) Reconfigures the instance of RecognizerRunner with new recognizers. The currently associated recognizer objects are un-associated from this RecognizerRunner and are elligible for calling the updateSettings() method on them after that. ###### Parameters ###### recognizers [`Recognizer`](#recognizer)[] Array of recognizer objects that should be associated with the RecognizerRunner. ###### allowMultipleResults `boolean` Whether or not it is allowed to return multiple results from single image. See README.md for more details about this option. ###### Returns `Promise`\<`void`\> ##### setMetadataCallbacks() > **setMetadataCallbacks**(`metadataCallbacks`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:174](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L174) Sets the new callbacks for obtaining recognition event. Make sure you call this method while image processing is not in progress, otherwise you will have undefined behaviour. ###### Parameters ###### metadataCallbacks {/* #metadatacallbacks-1 */} [`MetadataCallbacks`](#metadatacallbacks) Callback functions that will be called when certain recognition events occur. For more information, check the documentation of MetadataCallbacks class. ###### Returns `Promise`\<`void`\> ##### resetRecognizers() {/* #resetrecognizers */} > **resetRecognizers**(`hardReset`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:182](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L182) Resets the state of all recognizers in current recognition chain, i.e. deletes the cached data from multiple recognitions. ###### Parameters ###### hardReset `boolean` If set to false, multi-side recognizers will not be reset. If set to true, all recognizers will be reset. ###### Returns `Promise`\<`void`\> ##### setDetectionOnlyMode() > **setDetectionOnlyMode**(`detectionOnly`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:191](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L191) If enabled, recognizers will be instructed to only perform object detection, but not the entire recognition process. This is useful for testing your implementations of MetadataCallbacks without the need for the entire process to complete. Also, VideoRecognizers sets this to true only if in DetectionTest mode of video recognition. ###### Parameters ###### detectionOnly `boolean` Should recognizers perform only object detection. ###### Returns `Promise`\<`void`\> ##### setCameraPreviewMirrored() > **setCameraPreviewMirrored**(`mirrored`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:200](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L200) Sets whether camera preview displaying the image being recognized is being mirrored horizontally. If enabled, coordinates returned via metadatacallbacks will be adjusted accordingly due to the image being processed being different of image being displayed. The camera preview is usually mirrored when using front-facing camera. ###### Parameters ###### mirrored `boolean` Whether or not metadatacallbacks should adjust coordinates for mirrored image. ###### Returns `Promise`\<`void`\> *** ### WasmSDK Defined in: [src/MicroblinkSDK/DataStructures.ts:229](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L229) Specifies a main object that is used for communication with the WebAssembly module. This object is usually given as a parameter to functions that interop with the WebAssembly module. You can obtain an instance of this object after a promise from MicroblinkSDK.loadWasmModule is successfully resolved. #### Properties ##### mbWasmWorker > `readonly` **mbWasmWorker**: `Worker` Defined in: [src/MicroblinkSDK/DataStructures.ts:238](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L238) ##### delete() {/* #delete-6 */} > **delete**: () => `void` Defined in: [src/MicroblinkSDK/DataStructures.ts:240](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L240) ###### Returns `void` ##### getProductIntegrationInfo() > **getProductIntegrationInfo**: () => `Promise`\<[`ProductIntegrationInfo`](#productintegrationinfo)\> Defined in: [src/MicroblinkSDK/DataStructures.ts:242](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L242) ###### Returns `Promise`\<[`ProductIntegrationInfo`](#productintegrationinfo)\> ##### loadedWasmType > **loadedWasmType**: [`WasmType`](#wasmtype-1) Defined in: [src/MicroblinkSDK/DataStructures.ts:247](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L247) The type of the WASM that was actually loaded. ##### showOverlay > **showOverlay**: `boolean` Defined in: [src/MicroblinkSDK/DataStructures.ts:249](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L249) *** ### MBDate Defined in: [src/MicroblinkSDK/DataStructures.ts:256](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L256) Specifies a date object, as parsed from some documents. Unlike JavaScript Date object, it does not depend on time zone. #### Properties ##### day > `readonly` **day**: `number` Defined in: [src/MicroblinkSDK/DataStructures.ts:259](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L259) Day in month. ##### month > `readonly` **month**: `number` Defined in: [src/MicroblinkSDK/DataStructures.ts:262](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L262) Month in year. ##### year > `readonly` **year**: `number` Defined in: [src/MicroblinkSDK/DataStructures.ts:265](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L265) Year ##### originalString > `readonly` **originalString**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:268](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L268) Original string on the document from which date was parsed. ##### successfullyParsed > `readonly` **successfullyParsed**: `boolean` Defined in: [src/MicroblinkSDK/DataStructures.ts:271](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L271) Indicates whether date was parsed successfully. ##### empty > `readonly` **empty**: `boolean` Defined in: [src/MicroblinkSDK/DataStructures.ts:274](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L274) Indicates whether object is empty. Note that it is possible to successfully parse an empty date. *** ### SignedPayload Defined in: [src/MicroblinkSDK/DataStructures.ts:280](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L280) Specifies a digital signature of the specific recognizer result. #### Properties ##### payload > `readonly` **payload**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:283](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L283) The digital signature payload. ##### signature > `readonly` **signature**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:286](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L286) The digital signature of the payload. ##### signatureVersion > `readonly` **signatureVersion**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:289](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L289) Version of the digital signature. *** ### ProductIntegrationInfo Defined in: [src/MicroblinkSDK/DataStructures.ts:295](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L295) Describes a structure containing information about product integration. #### Properties ##### userId > `readonly` **userId**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:297](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L297) ##### licenseId > `readonly` **licenseId**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:299](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L299) ##### licensee > `readonly` **licensee**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:301](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L301) ##### productVersion > `readonly` **productVersion**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:303](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L303) ##### platform > `readonly` **platform**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:305](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L305) ##### device > `readonly` **device**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:307](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L307) ##### packageName > `readonly` **packageName**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:309](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L309) *** ### LicenseUnlockResult Defined in: [src/MicroblinkSDK/License.ts:15](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L15) #### Properties ##### allowRemoveDemoOverlay > `readonly` **allowRemoveDemoOverlay**: `boolean` Defined in: [src/MicroblinkSDK/License.ts:17](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L17) ##### allowRemoveProductionOverlay > `readonly` **allowRemoveProductionOverlay**: `boolean` Defined in: [src/MicroblinkSDK/License.ts:18](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L18) ##### isTrial > `readonly` **isTrial**: `boolean` Defined in: [src/MicroblinkSDK/License.ts:19](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L19) ##### licenseId > `readonly` **licenseId**: `string` Defined in: [src/MicroblinkSDK/License.ts:20](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L20) ##### licensee > `readonly` **licensee**: `string` Defined in: [src/MicroblinkSDK/License.ts:21](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L21) ##### applicationIds > `readonly` **applicationIds**: `string`[] Defined in: [src/MicroblinkSDK/License.ts:22](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L22) ##### packageName > `readonly` **packageName**: `string` Defined in: [src/MicroblinkSDK/License.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L23) ##### sdkName > `readonly` **sdkName**: `string` Defined in: [src/MicroblinkSDK/License.ts:24](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L24) ##### sdkVersion > `readonly` **sdkVersion**: `string` Defined in: [src/MicroblinkSDK/License.ts:25](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L25) ##### unlockResult > `readonly` **unlockResult**: [`LicenseTokenState`](#licensetokenstate) Defined in: [src/MicroblinkSDK/License.ts:26](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L26) ##### userId > `readonly` **userId**: `string` Defined in: [src/MicroblinkSDK/License.ts:27](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L27) ##### licenseError > `readonly` **licenseError**: `string` Defined in: [src/MicroblinkSDK/License.ts:28](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L28) *** ### ServerPermissionSubmitResult Defined in: [src/MicroblinkSDK/License.ts:97](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L97) #### Properties ##### status > `readonly` **status**: [`ServerPermissionSubmitResultStatus`](#serverpermissionsubmitresultstatus) Defined in: [src/MicroblinkSDK/License.ts:99](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L99) ##### lease > `readonly` **lease**: `number` Defined in: [src/MicroblinkSDK/License.ts:100](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L100) ##### networkErrorDescription? > `readonly` `optional` **networkErrorDescription**: `string` Defined in: [src/MicroblinkSDK/License.ts:101](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L101) *** ### UnlockResult Defined in: [src/MicroblinkSDK/License.ts:104](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L104) #### Properties ##### error {/* #error */} > `readonly` **error**: [`SDKError`](#sdkerror) \| `null` Defined in: [src/MicroblinkSDK/License.ts:106](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L106) ##### lease? > `readonly` `optional` **lease**: `number` Defined in: [src/MicroblinkSDK/License.ts:107](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L107) ##### showOverlay? > `readonly` `optional` **showOverlay**: `boolean` Defined in: [src/MicroblinkSDK/License.ts:108](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L108) *** ### MetadataCallbacks {/* #metadatacallbacks */} Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:12](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L12) Interface representing possible events that can occur during image processing. All functions in this interface are optional and will be called only if they are implemented. #### Methods ##### onDebugText()? > `optional` **onDebugText**(`debugTest`): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:18](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L18) Called when recognition process wants to display some debug text information. ###### Parameters ###### debugTest `string` Debug text information to be displayed. ###### Returns `void` ##### onDetectionFailed()? > `optional` **onDetectionFailed**(): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L23) Called when all recognizers in RecognizerRunner have failed to detect anything on the image. ###### Returns `void` ##### onQuadDetection()? > `optional` **onQuadDetection**(`quad`): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:29](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L29) Called when recognition process wants to display some quadrilateral. ###### Parameters ###### quad [`DisplayableQuad`](#displayablequad) Quadrilateral to be displayed. ###### Returns `void` ##### onPointsDetection()? > `optional` **onPointsDetection**(`pointSet`): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:35](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L35) Called when recognition process wants to display some points. ###### Parameters ###### pointSet [`DisplayablePoints`](#displayablepoints) Points to be displayed. ###### Returns `void` ##### onFirstSideResult()? > `optional` **onFirstSideResult**(): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:40](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L40) Called when first side recognition with the multi-side recognizer completes. ###### Returns `void` ##### onGlare()? > `optional` **onGlare**(`hasGlare`): `void` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:46](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L46) Called when glare detection has completed with result whether glare has been found or not. ###### Parameters ###### hasGlare `boolean` indicates whether glare has been found on the input image or not ###### Returns `void` *** ### Displayable Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:75](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L75) Interface representing any displayable object. #### Extended by - [`DisplayableQuad`](#displayablequad) - [`DisplayablePoints`](#displayablepoints) #### Properties ##### detectionStatus > **detectionStatus**: [`DetectionStatus`](#detectionstatus) Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:78](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L78) Detection status of the displayable object. ##### transformMatrix > **transformMatrix**: `Float32Array` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:83](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L83) 3x3 transformation matrix from the image's coordinate system to view's coordinate system. *** ### DisplayableQuad Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:89](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L89) Interface representing quadrilateral in image. #### Extends - [`Displayable`](#displayable).`Quadrilateral` #### Properties ##### topLeft > **topLeft**: `Point` Defined in: [src/MicroblinkSDK/Geometry.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/Geometry.ts#L23) Top-left point of the quadrilateral ###### Inherited from `Quadrilateral.topLeft` ##### topRight > **topRight**: `Point` Defined in: [src/MicroblinkSDK/Geometry.ts:26](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/Geometry.ts#L26) Top-right point of the quadrilateral ###### Inherited from `Quadrilateral.topRight` ##### bottomLeft > **bottomLeft**: `Point` Defined in: [src/MicroblinkSDK/Geometry.ts:29](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/Geometry.ts#L29) Bottom-left point of the quadrilateral ###### Inherited from `Quadrilateral.bottomLeft` ##### bottomRight > **bottomRight**: `Point` Defined in: [src/MicroblinkSDK/Geometry.ts:32](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/Geometry.ts#L32) Bottom-right point of the quadrilateral ###### Inherited from `Quadrilateral.bottomRight` ##### detectionStatus > **detectionStatus**: [`DetectionStatus`](#detectionstatus) Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:78](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L78) Detection status of the displayable object. ###### Inherited from [`Displayable`](#displayable).[`detectionStatus`](#detectionstatus-1) ##### transformMatrix > **transformMatrix**: `Float32Array` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:83](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L83) 3x3 transformation matrix from the image's coordinate system to view's coordinate system. ###### Inherited from [`Displayable`](#displayable).[`transformMatrix`](#transformmatrix) *** ### DisplayablePoints Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:95](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L95) Interface representing list of points in image. #### Extends - [`Displayable`](#displayable) #### Properties ##### detectionStatus > **detectionStatus**: [`DetectionStatus`](#detectionstatus) Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:78](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L78) Detection status of the displayable object. ###### Inherited from [`Displayable`](#displayable).[`detectionStatus`](#detectionstatus-1) ##### transformMatrix > **transformMatrix**: `Float32Array` Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:83](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L83) 3x3 transformation matrix from the image's coordinate system to view's coordinate system. ###### Inherited from [`Displayable`](#displayable).[`transformMatrix`](#transformmatrix) ##### points > **points**: `Point`[] Defined in: [src/MicroblinkSDK/MetadataCallbacks.ts:98](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MetadataCallbacks.ts#L98) Array of points *** ### TieredCheck Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:69](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L69) #### Properties ##### result > **result**: [`CheckResult`](#checkresult) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:70](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L70) ##### matchLevel > **matchLevel**: [`MatchLevel`](#matchlevel) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:71](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L71) *** ### DocumentLivenessCheckSingleSideResult Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:74](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L74) #### Properties ##### screenCheck > **screenCheck**: [`TieredCheck`](#tieredcheck) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:75](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L75) ##### photocopyCheck > **photocopyCheck**: [`TieredCheck`](#tieredcheck) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:76](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L76) ##### handPresenceCheck > **handPresenceCheck**: [`CheckResult`](#checkresult) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:77](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L77) *** ### DocumentLivenessCheck Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:80](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L80) #### Properties ##### front > **front**: [`DocumentLivenessCheckSingleSideResult`](#documentlivenesschecksinglesideresult) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L81) ##### back > **back**: [`DocumentLivenessCheckSingleSideResult`](#documentlivenesschecksinglesideresult) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:82](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L82) *** ### BlinkCardRecognizerResult Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:254](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L254) The result of image recognition when using the BlinkCardRecognizer. #### Extends - [`RecognizerResult`](#recognizerresult) #### Properties ##### state > `readonly` **state**: [`RecognizerResultState`](#recognizerresultstate) Defined in: [src/MicroblinkSDK/DataStructures.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L90) State of the recognition result. See the documentation for RecognizerResultState for more information. ###### Inherited from [`RecognizerResult`](#recognizerresult).[`state`](#state) ##### cardNumber > `readonly` **cardNumber**: `string` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:259](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L259) The payment card number. ##### cardNumberPrefix > `readonly` **cardNumberPrefix**: `string` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:264](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L264) The payment card number prefix. ##### cardNumberValid > `readonly` **cardNumberValid**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:269](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L269) The payment card number. ##### cvv > `readonly` **cvv**: `string` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:274](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L274) Payment card's security code/value. ##### expiryDate > `readonly` **expiryDate**: [`MBDate`](#mbdate) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:279](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L279) The payment card's expiry date. ##### firstSideBlurred > `readonly` **firstSideBlurred**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:284](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L284) Wheater the first scanned side is blurred. ##### firstSideFullDocumentImage > `readonly` **firstSideFullDocumentImage**: `ImageResult` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:289](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L289) Full image of the payment card from first side recognition. ##### iban > `readonly` **iban**: `string` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:294](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L294) Payment card's IBAN. ##### issuer > `readonly` **issuer**: [`CardIssuer`](#cardissuer) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:299](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L299) Payment card's issuing network ##### owner > `readonly` **owner**: `string` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:304](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L304) Information about the payment card owner. ##### processingStatus {/* #processingstatus */} > `readonly` **processingStatus**: [`ProcessingStatus`](#processingstatus-1) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:309](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L309) Status of the last recognition process. ##### scanningFirstSideDone > `readonly` **scanningFirstSideDone**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:314](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L314) Whether the scanning of the first side is finished. ##### secondSideBlurred > `readonly` **secondSideBlurred**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:319](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L319) Wheater the second scanned side is blurred. ##### secondSideFullDocumentImage > `readonly` **secondSideFullDocumentImage**: `ImageResult` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:324](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L324) Full image of the payment card from second side recognition. ##### firstSideAnonymized > `readonly` **firstSideAnonymized**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:329](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L329) Is front side anonymized. ##### secondSideAnonymized > `readonly` **secondSideAnonymized**: `boolean` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:334](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L334) Is back side anonymized. ##### documentLivenessCheck > `readonly` **documentLivenessCheck**: [`DocumentLivenessCheck`](#documentlivenesscheck) Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:339](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L339) Document liveness check for both sides (screen, photocopy, hand presence); *** ### BlinkCardRecognizer Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:345](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L345) The Blink Card Recognizer is used for scanning Blink Card. #### Extends - [`Recognizer`](#recognizer) #### Properties ##### recognizerName > `readonly` **recognizerName**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:109](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L109) Name of this recognizer. ###### Inherited from [`Recognizer`](#recognizer).[`recognizerName`](#recognizername) #### Methods ##### delete() {/* #delete-7 */} > **delete**(): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:81](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L81) Cleans up the object from the WebAssembly heap. ###### Returns `Promise`\<`void`\> ###### Inherited from [`Recognizer`](#recognizer).[`delete`](#delete-2) ##### toSignedJSON() {/* #tosignedjson-2 */} > **toSignedJSON**(): `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:136](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L136) Returns the JSON representation of the recognizer's result. The JSON will be digitally signed and can be used to verify that the result was provided by the SDK and that it hasn't been manually altered. If the SDK does not have this feature compiled into the WASM, this method will return null. ###### Returns `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> ###### Inherited from [`Recognizer`](#recognizer).[`toSignedJSON`](#tosignedjson) ##### currentSettings() {/* #currentsettings-2 */} > **currentSettings**(): `Promise`\<[`BlinkCardRecognizerSettings`](#blinkcardrecognizersettings)\> Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:348](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L348) Returns the currently applied BlinkCardRecognizerSettings. ###### Returns `Promise`\<[`BlinkCardRecognizerSettings`](#blinkcardrecognizersettings)\> ###### Overrides [`Recognizer`](#recognizer).[`currentSettings`](#currentsettings) ##### updateSettings() {/* #updatesettings-2 */} > **updateSettings**(`newSettings`): `Promise`\<`void`\> Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:351](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L351) Applies new settings to the recognizer. ###### Parameters ###### newSettings [`BlinkCardRecognizerSettings`](#blinkcardrecognizersettings) ###### Returns `Promise`\<`void`\> ###### Overrides [`Recognizer`](#recognizer).[`updateSettings`](#updatesettings) ##### getResult() {/* #getresult-2 */} > **getResult**(): `Promise`\<[`BlinkCardRecognizerResult`](#blinkcardrecognizerresult)\> Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:354](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L354) Returns the current result of the recognition. ###### Returns `Promise`\<[`BlinkCardRecognizerResult`](#blinkcardrecognizerresult)\> ###### Overrides [`Recognizer`](#recognizer).[`getResult`](#getresult) *** ### SuccessFrameGrabberRecognizerResult Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:16](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L16) The result object of the SuccessFrameGrabberRecognizer. #### Extends - [`RecognizerResult`](#recognizerresult) #### Properties ##### state > `readonly` **state**: [`RecognizerResultState`](#recognizerresultstate) Defined in: [src/MicroblinkSDK/DataStructures.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L90) State of the recognition result. See the documentation for RecognizerResultState for more information. ###### Inherited from [`RecognizerResult`](#recognizerresult).[`state`](#state) ##### successFrame > `readonly` **successFrame**: `ImageData` \| `null` Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:22](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L22) Camera frame on which given recognizer's result ha become valid. If given recognizer's result never became valid, contains null. ##### frameOrientation > `readonly` **frameOrientation**: [`ImageOrientation`](#imageorientation) Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:27](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L27) Orientation of the success frame. *** ### SuccessFrameGrabberRecognizer Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:34](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L34) Recognizer that can wrap another recognizer and capture the frame on which the wrapped recognizer has succeeded to recognize. #### Extends - [`Recognizer`](#recognizer) #### Type Parameters ##### T `T` *extends* [`Recognizer`](#recognizer) #### Properties ##### recognizerName > `readonly` **recognizerName**: `string` Defined in: [src/MicroblinkSDK/DataStructures.ts:109](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L109) Name of this recognizer. ###### Inherited from [`Recognizer`](#recognizer).[`recognizerName`](#recognizername) ##### wrappedRecognizer > `readonly` **wrappedRecognizer**: `T` Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:40](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L40) Reference to recognizer that is being wrapped by this SuccessFrameGrabberRecognizer. #### Methods ##### currentSettings() {/* #currentsettings-4 */} > **currentSettings**(): `Promise`\<[`RecognizerSettings`](#recognizersettings)\> Defined in: [src/MicroblinkSDK/DataStructures.ts:114](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L114) Returns the currently applied settings to the specific recognizer. ###### Returns `Promise`\<[`RecognizerSettings`](#recognizersettings)\> ###### Inherited from [`Recognizer`](#recognizer).[`currentSettings`](#currentsettings) ##### updateSettings() {/* #updatesettings-4 */} > **updateSettings**(`newSettings`): `Promise`\<`void`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:121](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L121) Applies the new settings to the specific recognizer. Note: if the recognizer is associated with RecognizerRunner, this method will fail. ###### Parameters ###### newSettings [`RecognizerSettings`](#recognizersettings) New settings to be applied to the recognizer. ###### Returns `Promise`\<`void`\> ###### Inherited from [`Recognizer`](#recognizer).[`updateSettings`](#updatesettings) ##### toSignedJSON() {/* #tosignedjson-4 */} > **toSignedJSON**(): `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> Defined in: [src/MicroblinkSDK/DataStructures.ts:136](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DataStructures.ts#L136) Returns the JSON representation of the recognizer's result. The JSON will be digitally signed and can be used to verify that the result was provided by the SDK and that it hasn't been manually altered. If the SDK does not have this feature compiled into the WASM, this method will return null. ###### Returns `Promise`\<[`SignedPayload`](#signedpayload) \| `null`\> ###### Inherited from [`Recognizer`](#recognizer).[`toSignedJSON`](#tosignedjson) ##### getResult() {/* #getresult-4 */} > **getResult**(): `Promise`\<[`SuccessFrameGrabberRecognizerResult`](#successframegrabberrecognizerresult)\> Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:47](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L47) Returns the current result of the recognition. Note that result will not contain the result of the wrapped recognizer. To obtain that result, call getResult on wrapped recognizer. ###### Returns `Promise`\<[`SuccessFrameGrabberRecognizerResult`](#successframegrabberrecognizerresult)\> ###### Overrides [`Recognizer`](#recognizer).[`getResult`](#getresult) ##### delete() {/* #delete-9 */} > **delete**(): `Promise`\<`void`\> Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L52) Cleans up the object from the WebAssembly heap. ###### Returns `Promise`\<`void`\> ###### Overrides [`Recognizer`](#recognizer).[`delete`](#delete-2) ## Type Aliases ### OnScanningDone() {/* #onscanningdone */} > **OnScanningDone** = (`recognitionState`) => `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:51](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L51) Invoked when VideoRecognizer finishes the recognition of the video stream. #### Parameters ##### recognitionState [`RecognizerResultState`](#recognizerresultstate) The state of recognition after finishing. If `Empty` or `Uncertain` are returned, this indicates that the scanning was cancelled or timeout has been reached. #### Returns `void` *** ### OnFrameProcessed() {/* #onframeprocessed */} > **OnFrameProcessed** = (`result`, `frame`) => `void` Defined in: [src/MicroblinkSDK/VideoRecognizer.ts:53](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/VideoRecognizer.ts#L53) #### Parameters ##### result [`BlinkCardRecognizerResult`](#blinkcardrecognizerresult) ##### frame `ImageData` #### Returns `void` *** ### LoadProgressCallback() {/* #loadprogresscallback */} > **LoadProgressCallback** = (`loadPercentage`) => `void` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:14](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L14) Function that will be called during loading of the SDK. #### Parameters ##### loadPercentage `number` Number between 0 and 100 indicating the loading progress. #### Returns `void` *** ### OptionalLoadProgressCallback > **OptionalLoadProgressCallback** = [`LoadProgressCallback`](#loadprogresscallback) \| `null` Defined in: [src/MicroblinkSDK/WasmLoadSettings.ts:16](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadSettings.ts#L16) *** ### DocumentLivenessCallback() {/* #documentlivenesscallback */} > **DocumentLivenessCallback** = (`livenessStatus`) => `void` Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:47](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L47) #### Parameters ##### livenessStatus [`LivenessStatus`](#livenessstatus) #### Returns `void` ## Variables ### videoRecognizerErrors > `const` **videoRecognizerErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:110](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L110) #### Type Declaration ##### feedMissing > **feedMissing**: `object` ###### feedMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_FEED_MISSING` ###### feedMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_FEED_MISSING` ##### recognizersResetFailure > **recognizersResetFailure**: `object` ###### recognizersResetFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE` ###### recognizersResetFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE` ##### feedPaused > **feedPaused**: `object` ###### feedPaused.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_FEED_PAUSED` ###### feedPaused.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_FEED_PAUSED` ##### playRequestInterrupted > **playRequestInterrupted**: `object` ###### playRequestInterrupted.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED` ###### playRequestInterrupted.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED` ##### videoFeedNotPaused > **videoFeedNotPaused**: `object` ###### videoFeedNotPaused.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_FEED_NOT_PAUSED` ###### videoFeedNotPaused.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_FEED_NOT_PAUSED` ##### videoFeedReleased > **videoFeedReleased**: `object` ###### videoFeedReleased.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_FEED_RELEASED` ###### videoFeedReleased.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_FEED_RELEASED` ##### mediaDevicesUnsupported > **mediaDevicesUnsupported**: `object` ###### mediaDevicesUnsupported.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED` ###### mediaDevicesUnsupported.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED` ##### cameraMissing > **cameraMissing**: `object` ###### cameraMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_CAMERA_MISSING` ###### cameraMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_CAMERA_MISSING` ##### cameraNotAllowed > **cameraNotAllowed**: `object` ###### cameraNotAllowed.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED` ###### cameraNotAllowed.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED` ##### elementMissing > **elementMissing**: `object` ###### elementMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.VIDEO_RECOGNIZER_ELEMENT_MISSING` ###### elementMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.VIDEO_RECOGNIZER_ELEMENT_MISSING` *** ### sdkErrors > `const` **sdkErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:153](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L153) #### Type Declaration ##### wasmSettingsMissing > **wasmSettingsMissing**: `object` ###### wasmSettingsMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_WASM_SETTINGS_MISSING` ###### wasmSettingsMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_WASM_SETTINGS_MISSING` ##### licenseKeyMissing > **licenseKeyMissing**: `object` ###### licenseKeyMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_LICENSE_KEY_MISSING` ###### licenseKeyMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_LICENSE_KEY_MISSING` ##### wasmModuleNameMissing > **wasmModuleNameMissing**: `object` ###### wasmModuleNameMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_WASM_MODULE_NAME_MISSING` ###### wasmModuleNameMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_WASM_MODULE_NAME_MISSING` ##### engineLocationInvalid > **engineLocationInvalid**: `object` ###### engineLocationInvalid.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_ENGINE_LOCATION_INVALID` ###### engineLocationInvalid.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_ENGINE_LOCATION_INVALID` ##### workerLocationInvalid > **workerLocationInvalid**: `object` ###### workerLocationInvalid.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_WORKER_LOCATION_INVALID` ###### workerLocationInvalid.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_WORKER_LOCATION_INVALID` ##### missing > **missing**: `object` ###### missing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_MISSING` ###### missing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_MISSING` ##### recognizersMissing > **recognizersMissing**: `object` ###### recognizersMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.SDK_RECOGNIZERS_MISSING` ###### recognizersMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.SDK_RECOGNIZERS_MISSING` *** ### frameCaptureErrors > `const` **frameCaptureErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:184](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L184) #### Type Declaration ##### svgUnsupported > **svgUnsupported**: `object` ###### svgUnsupported.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.FRAME_CAPTURE_SVG_UNSUPPORTED` ###### svgUnsupported.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.FRAME_CAPTURE_SVG_UNSUPPORTED` ##### canvasMissing > **canvasMissing**: `object` ###### canvasMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.FRAME_CAPTURE_CANVAS_MISSING` ###### canvasMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.FRAME_CAPTURE_CANVAS_MISSING` *** ### licenseErrors > `const` **licenseErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:195](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L195) #### Type Declaration ##### licenseTokenStateIncorrect > **licenseTokenStateIncorrect**: `object` ###### licenseTokenStateIncorrect.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ###### licenseTokenStateIncorrect.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LICENSE_TOKEN_STATE_INCORRECT` ##### licensePayloadVerificationFailed > **licensePayloadVerificationFailed**: `object` ###### licensePayloadVerificationFailed.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ###### licensePayloadVerificationFailed.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LICENSE_PAYLOAD_VERIFICATION_FAILED` ##### licensePayloadCorrupted > **licensePayloadCorrupted**: `object` ###### licensePayloadCorrupted.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ###### licensePayloadCorrupted.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LICENSE_PAYLOAD_CORRUPTED` ##### licensePermissionExpired > **licensePermissionExpired**: `object` ###### licensePermissionExpired.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ###### licensePermissionExpired.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LICENSE_PERMISSION_EXPIRED` ##### licenseRemoteLocked > **licenseRemoteLocked**: `object` ###### licenseRemoteLocked.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ###### licenseRemoteLocked.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LICENSE_REMOTE_LOCKED` ##### licenseNetworkError > **licenseNetworkError**: `object` ###### licenseNetworkError.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` ##### licenseInvalid > **licenseInvalid**: `object` ###### licenseInvalid.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LICENSE_UNLOCK_ERROR` *** ### localSdkErrors > `const` **localSdkErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:224](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L224) #### Type Declaration ##### runnerMissing > **runnerMissing**: `object` ###### runnerMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LOCAL_SDK_RUNNER_MISSING` ###### runnerMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LOCAL_SDK_RUNNER_MISSING` ##### runnerEmpty > **runnerEmpty**: `object` ###### runnerEmpty.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.LOCAL_SDK_RUNNER_EMPTY` ###### runnerEmpty.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.LOCAL_SDK_RUNNER_EMPTY` *** ### workerErrors > `const` **workerErrors**: `object` Defined in: [src/MicroblinkSDK/ErrorTypes.ts:235](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/ErrorTypes.ts#L235) #### Type Declaration ##### imageProcessFailure > **imageProcessFailure**: `object` ###### imageProcessFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_IMAGE_PROCESS_FAILURE` ###### imageProcessFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_IMAGE_PROCESS_FAILURE` ##### objectInvokeFailure > **objectInvokeFailure**: `object` ###### objectInvokeFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_OBJECT_INVOKE_FAILURE` ###### objectInvokeFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_OBJECT_INVOKE_FAILURE` ##### runnerDeleteFailure > **runnerDeleteFailure**: `object` ###### runnerDeleteFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_DELETE_FAILURE` ###### runnerDeleteFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_DELETE_FAILURE` ##### runnerDeleted > **runnerDeleted**: `object` ###### runnerDeleted.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_DELETED` ###### runnerDeleted.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_DELETED` ##### runnerReconfigureFailure > **runnerReconfigureFailure**: `object` ###### runnerReconfigureFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_RECONFIGURE_FAILURE` ###### runnerReconfigureFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_RECONFIGURE_FAILURE` ##### runnerMissing > **runnerMissing**: `object` ###### runnerMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_MISSING` ###### runnerMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_MISSING` ##### runnerCreationFailure > **runnerCreationFailure**: `object` ###### runnerCreationFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_CREATION_FAILURE` ###### runnerCreationFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_CREATION_FAILURE` ##### runnerExists > **runnerExists**: `object` ###### runnerExists.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RUNNER_EXISTS` ###### runnerExists.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RUNNER_EXISTS` ##### recognizerCreationFailure > **recognizerCreationFailure**: `object` ###### recognizerCreationFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_RECOGNIZER_CREATION_FAILURE` ###### recognizerCreationFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_RECOGNIZER_CREATION_FAILURE` ##### functionInvokeFailure > **functionInvokeFailure**: `object` ###### functionInvokeFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_FUNCTION_INVOKE_FAILURE` ###### functionInvokeFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_FUNCTION_INVOKE_FAILURE` ##### wasmInitMissing > **wasmInitMissing**: `object` ###### wasmInitMissing.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_WASM_INIT_MISSING` ###### wasmInitMissing.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_WASM_INIT_MISSING` ##### wasmLoadFailure > **wasmLoadFailure**: `object` ###### wasmLoadFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_WASM_LOAD_FAILURE` ###### wasmLoadFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_WASM_LOAD_FAILURE` ##### handleUndefined > **handleUndefined**: `object` ###### handleUndefined.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_HANDLE_UNDEFINED` ###### handleUndefined.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_HANDLE_UNDEFINED` ##### integrationInfoFailure > **integrationInfoFailure**: `object` ###### integrationInfoFailure.message > **message**: [`ErrorMessages`](#errormessages) = `ErrorMessages.WORKER_INTEGRATION_INFO_FAILURE` ###### integrationInfoFailure.code > **code**: [`ErrorCodes`](#errorcodes) = `ErrorCodes.WORKER_INTEGRATION_INFO_FAILURE` ## Functions ### isAndroidDevice() > **isAndroidDevice**(): `boolean` Defined in: [src/MicroblinkSDK/CameraUtils.ts:147](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L147) #### Returns `boolean` *** ### isIOSDevice() > **isIOSDevice**(): `boolean` Defined in: [src/MicroblinkSDK/CameraUtils.ts:153](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L153) #### Returns `boolean` *** ### isMobileDevice() > **isMobileDevice**(): `boolean` Defined in: [src/MicroblinkSDK/CameraUtils.ts:159](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L159) #### Returns `boolean` *** ### getCameraDevices() > **getCameraDevices**(): `Promise`\<[`CameraDevices`](#cameradevices)\> Defined in: [src/MicroblinkSDK/CameraUtils.ts:207](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L207) #### Returns `Promise`\<[`CameraDevices`](#cameradevices)\> *** ### selectCamera() > **selectCamera**(`cameraId`, `preferredCameraType`): `Promise`\<[`SelectedCamera`](#selectedcamera) \| `null`\> Defined in: [src/MicroblinkSDK/CameraUtils.ts:274](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L274) #### Parameters ##### cameraId `string` | `null` ##### preferredCameraType [`PreferredCameraType`](#preferredcameratype) #### Returns `Promise`\<[`SelectedCamera`](#selectedcamera) \| `null`\> *** ### bindCameraToVideoFeed() > **bindCameraToVideoFeed**(`camera`, `videoFeed`, `preferredCameraType`): `Promise`\<`boolean`\> Defined in: [src/MicroblinkSDK/CameraUtils.ts:450](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/CameraUtils.ts#L450) Bind camera device to video feed (HTMLVideoElement). This function will return `true` in case that video feed of camera device has been flipped, and `false` otherwise. #### Parameters ##### camera [`SelectedCamera`](#selectedcamera) Camera device which should be binded with the video element. ##### videoFeed `HTMLVideoElement` HTMLVideoElement to which camera device should be binded. ##### preferredCameraType [`PreferredCameraType`](#preferredcameratype) = `PreferredCameraType.BackFacingCamera` Enum representing whether to use front facing or back facing camera. #### Returns `Promise`\<`boolean`\> *** ### isBrowserSupported() > **isBrowserSupported**(): `boolean` Defined in: [src/MicroblinkSDK/DeviceUtils.ts:10](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DeviceUtils.ts#L10) Checks if browser is supported by the SDK. The minimum requirements for the browser is the support for WebAssembly. If your browser does not support executing WebAssembly, this function will return `false`. #### Returns `boolean` *** ### isInAppBrowser() > **isInAppBrowser**(): `boolean` Defined in: [src/MicroblinkSDK/DeviceUtils.ts:34](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/DeviceUtils.ts#L34) Check if current browser is in-app / embedded. Detects Instagram, Facebook, LinkedIn, Twitter, WeChat, Whatsapp, and Tiktok. #### Returns `boolean` Boolean whether the browser is in-app or not *** ### captureFrame() > **captureFrame**(`imageSource`, `shouldCrop`): [`CapturedFrame`](#capturedframe) Defined in: [src/MicroblinkSDK/FrameCapture.ts:52](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/FrameCapture.ts#L52) Captures a frame from any CanvasImageSource, such as HTMLVideoElement or HTMLImageElement. #### Parameters ##### imageSource `CanvasImageSource` image source from which frame should be captured ##### shouldCrop `boolean` = `false` #### Returns [`CapturedFrame`](#capturedframe) instance of CapturedFrame *** ### obtainNewServerPermission() > **obtainNewServerPermission**(`unlockResult`, `wasmModule`): `Promise`\<[`ServerPermissionSubmitResult`](#serverpermissionsubmitresult)\> Defined in: [src/MicroblinkSDK/License.ts:116](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L116) #### Parameters ##### unlockResult [`LicenseUnlockResult`](#licenseunlockresult) ##### wasmModule `any` #### Returns `Promise`\<[`ServerPermissionSubmitResult`](#serverpermissionsubmitresult)\> *** ### unlockWasmSDK() > **unlockWasmSDK**(`licenseKey`, `allowHelloMessage`, `userId`, `wasmModule`): `Promise`\<[`UnlockResult`](#unlockresult-1)\> Defined in: [src/MicroblinkSDK/License.ts:163](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/License.ts#L163) #### Parameters ##### licenseKey `string` ##### allowHelloMessage `boolean` ##### userId `string` ##### wasmModule `any` #### Returns `Promise`\<[`UnlockResult`](#unlockresult-1)\> *** ### loadWasmModule() > **loadWasmModule**(`loadSettings`): `Promise`\<`any`\> Defined in: [src/MicroblinkSDK/MicroblinkSDK.ts:69](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MicroblinkSDK.ts#L69) Asynchronously loads and compiles the WebAssembly module. #### Parameters ##### loadSettings [`WasmSDKLoadSettings`](#wasmsdkloadsettings) Object defining the settings for loading the WebAssembly module. #### Returns `Promise`\<`any`\> Promise that resolves if WebAssembly module was successfully loaded and rejects if not. *** ### createRecognizerRunner() > **createRecognizerRunner**(`wasmSDK`, `recognizers`, `allowMultipleResults`, `metadataCallbacks`): `Promise`\<[`RecognizerRunner`](#recognizerrunner)\> Defined in: [src/MicroblinkSDK/MicroblinkSDK.ts:146](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/MicroblinkSDK.ts#L146) Function for creating a new RecognizerRunner. Note that it is currently not possible to have multiple instances of RecognizerRunner per instance of WasmSDK. Attempt to create new instance of RecognizerRunner prior deleting the previous one will fail. #### Parameters ##### wasmSDK [`WasmSDK`](#wasmsdk) Instance of WasmSDK which will be used to communicate with the WebAssembly module. ##### recognizers [`Recognizer`](#recognizer)[] Array of recognizers that will be used by RecognizerRunner. ##### allowMultipleResults `boolean` = `false` Whether or not it is allowed to return multiple results from single recognition session. See README.md for more information. ##### metadataCallbacks [`MetadataCallbacks`](#metadatacallbacks) = `{}` #### Returns `Promise`\<[`RecognizerRunner`](#recognizerrunner)\> *** ### isSafari() > **isSafari**(): `boolean` Defined in: [src/MicroblinkSDK/WasmLoadUtils.ts:17](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadUtils.ts#L17) #### Returns `boolean` *** ### isIOSUserAgent() > **isIOSUserAgent**(): `boolean` Defined in: [src/MicroblinkSDK/WasmLoadUtils.ts:23](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadUtils.ts#L23) #### Returns `boolean` *** ### detectWasmFeatures() > **detectWasmFeatures**(): `Promise`\<[`WasmType`](#wasmtype-1)\> Defined in: [src/MicroblinkSDK/WasmLoadUtils.ts:55](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadUtils.ts#L55) #### Returns `Promise`\<[`WasmType`](#wasmtype-1)\> *** ### detectWasmType() > **detectWasmType**(): `Promise`\<[`WasmType`](#wasmtype-1)\> Defined in: [src/MicroblinkSDK/WasmLoadUtils.ts:90](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadUtils.ts#L90) #### Returns `Promise`\<[`WasmType`](#wasmtype-1)\> *** ### wasmFolder() > **wasmFolder**(`wasmType`): `string` Defined in: [src/MicroblinkSDK/WasmLoadUtils.ts:116](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/MicroblinkSDK/WasmLoadUtils.ts#L116) #### Parameters ##### wasmType [`WasmType`](#wasmtype-1) #### Returns `string` *** ### createBlinkCardRecognizer() > **createBlinkCardRecognizer**(`wasmSDK`): `Promise`\<[`BlinkCardRecognizer`](#blinkcardrecognizer)\> Defined in: [src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:361](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/BlinkCard/BlinkCardRecognizer.ts#L361) This function is used to create a new instance of `BlinkCardRecognizer`. #### Parameters ##### wasmSDK [`WasmSDK`](#wasmsdk) Instance of WasmSDK which will be used to communicate with the WebAssembly module. #### Returns `Promise`\<[`BlinkCardRecognizer`](#blinkcardrecognizer)\> *** ### createSuccessFrameGrabberRecognizer() > **createSuccessFrameGrabberRecognizer**\<`T`\>(`wasmSDK`, `slaveRecognizer`): `Promise`\<[`SuccessFrameGrabberRecognizer`](#successframegrabberrecognizer)\<`T`\>\> Defined in: [src/Recognizers/SuccessFrameGrabberRecognizer.ts:61](https://github.com/BlinkCard/blinkcard-in-browser/blob/master/src/Recognizers/SuccessFrameGrabberRecognizer.ts#L61) Creates a new instance of `SuccessFrameGrabberRecognizer`. #### Type Parameters ##### T `T` *extends* [`Recognizer`](#recognizer) #### Parameters ##### wasmSDK [`WasmSDK`](#wasmsdk) Instance of WasmSDK which will be used to communicate with the WebAssembly module. ##### slaveRecognizer `T` Instance of Recognizer that will be wrapped. #### Returns `Promise`\<[`SuccessFrameGrabberRecognizer`](#successframegrabberrecognizer)\<`T`\>\> Last updated on Apr 16, 2026