BlinkIdUxManager
@microblink/blinkid / BlinkIdUxManager
Class: BlinkIdUxManager
The BlinkIdUxManager class. This is the main class that manages the UX of the BlinkID SDK. It is responsible for handling the UI state, the timeout, the help tooltip, and the document class filter.
Constructors
Constructor
new BlinkIdUxManager(
cameraManager,scanningSession):BlinkIdUxManager
The constructor for the BlinkIdUxManager class.
Parameters
cameraManager
The camera manager.
scanningSession
The scanning session.
Returns
BlinkIdUxManager
Properties
cameraManager
cameraManager:
CameraManager
The camera manager.
clearScanTimeout()
clearScanTimeout: () =>
void
Clears the scanning session timeout.
Returns
void
feedbackStabilizer
feedbackStabilizer:
FeedbackStabilizer<BlinkIdUiStateMap>
The feedback stabilizer.
rawUiStateKey
rawUiStateKey:
BlinkIdUiStateKey
The raw UI state key.
scanningSession
scanningSession:
RemoteScanningSession
The scanning session.
sessionSettings
sessionSettings:
BlinkIdSessionSettings
The session settings.
showDemoOverlay
showDemoOverlay:
boolean
Whether the demo overlay should be shown.
showProductionOverlay
showProductionOverlay:
boolean
Whether the production overlay should be shown.
uiState
uiState:
BlinkIdUiState
The current UI state.
Methods
addDocumentClassFilter()
addDocumentClassFilter(
callback): () =>void
Registers a callback function to filter document classes.
Parameters
callback
A function that will be called with the document class info.
Returns
A cleanup function that, when called, will remove the registered callback.
():
void
Returns
void
Example
const cleanup = manager.addDocumentClassFilter((docClassInfo) => {
return docClassInfo.country === 'usa';
});
// Later, to remove the callback:
cleanup();
addOnDocumentFilteredCallback()
addOnDocumentFilteredCallback(
callback): () =>void
Registers a callback function to be called when a document is filtered.
Parameters
callback
(documentClassInfo) => void
A function that will be called with the document class info.
Returns
A cleanup function that, when called, will remove the registered callback.
():
void
Returns
void
Example
const cleanup = manager.addOnDocumentFilteredCallback((docClassInfo) => {
console.log('Document filtered:', docClassInfo);
});
// Later, to remove the callback:
cleanup();
addOnErrorCallback()
addOnErrorCallback(
callback): () =>void
Registers a callback function to be called when an error occurs during processing.
Parameters
callback
(errorState) => void
A function that will be called with the error state.
Returns
A cleanup function that, when called, will remove the registered callback.
():
void
Returns
void
Example
const cleanup = manager.addOnErrorCallback((error) => {
console.error('Processing error:', error);
});
// Later, to remove the callback:
cleanup();
addOnFrameProcessCallback()
addOnFrameProcessCallback(
callback): () =>void
Registers a callback function to be called when a frame is processed.
Parameters
callback
(frameResult) => void
A function that will be called with the frame analysis result.
Returns
A cleanup function that, when called, will remove the registered callback.
():
void
Returns
void
Example
const cleanup = manager.addOnFrameProcessCallback((frameResult) => {
console.log('Frame processed:', frameResult);
});
// Later, to remove the callback:
cleanup();
addOnResultCallback()
addOnResultCallback(
callback): () =>void
Registers a callback function to be called when a scan result is available.
Parameters
callback
(result) => void
A function that will be called with the scan result.
Returns
A cleanup function that, when called, will remove the registered callback.
():
void
Returns
void
Example
const cleanup = manager.addOnResultCallback((result) => {
console.log('Scan result:', result);
});
// Later, to remove the callback:
cleanup();
addOnUiStateChangedCallback()
addOnUiStateChangedCallback(
callback): () =>void
Adds a callback function to be executed when the UI state changes.
Parameters
callback
(uiState) => void
Function to be called when UI state changes. Receives the new UI state as parameter.
Returns
A cleanup function that removes the callback when called.
():
void
Returns
void
Example
const cleanup = manager.addOnUiStateChangedCallback((newState) => {
console.log('UI state changed to:', newState);
});
cleanup();
cleanupAllObservers()
cleanupAllObservers():
void
Returns
void
clearUserCallbacks()
clearUserCallbacks():
void
Returns
void
getHapticFeedbackManager()
getHapticFeedbackManager():
HapticFeedbackManager
Gets the haptic feedback manager instance.
Returns
The haptic feedback manager
getHelpTooltipHideDelay()
getHelpTooltipHideDelay():
null|number
Returns the time in ms before the help tooltip is hidden. Null if tooltip won't be auto hidden.
Returns
null | number
getHelpTooltipShowDelay()
getHelpTooltipShowDelay():
null|number
Returns the time in ms before the help tooltip is shown. Null if tooltip won't be auto shown.
Returns
null | number
getSessionResult()
getSessionResult(
deleteSession?):Promise<BlinkIdScanningResult>
Gets the result from the scanning session.
Parameters
deleteSession?
boolean
Whether to delete the session after getting the result. Note that it is not possible to get the result a second time after the document has been fully captured, so in this case we should delete the scanning session since it is no longer needed.
Returns
Promise<BlinkIdScanningResult>
The result.
getShowDemoOverlay()
getShowDemoOverlay():
boolean
Indicates whether the UI should display the demo overlay. Controlled by the license property.
Returns
boolean
getShowProductionOverlay()
getShowProductionOverlay():
boolean
Indicates whether the UI should display the production overlay. Controlled by the license property.
Returns
boolean
getTimeoutDuration()
getTimeoutDuration():
null|number
Returns the timeout duration in ms. Null if timeout won't be triggered ever.
Returns
null | number
isHapticFeedbackEnabled()
isHapticFeedbackEnabled():
boolean
Check if haptic feedback is currently enabled.
Returns
boolean
true if haptic feedback is enabled
isHapticFeedbackSupported()
isHapticFeedbackSupported():
boolean
Check if haptic feedback is supported by the current browser/device.
Returns
boolean
true if haptic feedback is supported
reset()
reset():
void
Resets the BlinkIdUxManager. Clears all callbacks.
Does not reset the camera manager or the scanning session.
Returns
void
resetScanningSession()
resetScanningSession(
startFrameCapture?):Promise<void>
Resets the scanning session.
Parameters
startFrameCapture?
boolean
Whether to start frame processing.
Returns
Promise<void>
safelyDeleteScanningSession()
safelyDeleteScanningSession():
Promise<void>
Safely deletes the scanning session.
Returns
Promise<void>
setHapticFeedbackEnabled()
setHapticFeedbackEnabled(
enabled):void
Enable or disable haptic feedback.
Parameters
enabled
boolean
Whether haptic feedback should be enabled
Returns
void
setHelpTooltipHideDelay()
setHelpTooltipHideDelay(
duration):void
Sets the duration in milliseconds before the help tooltip is hidden. A value of null means the help tooltip will not be auto hidden.
Parameters
duration
The duration in milliseconds before the help tooltip is hidden. If null, tooltip won't be auto hidden.
null | number
Returns
void
Throws
Throws an error if duration is less than or equal to 0 when not null.
setHelpTooltipShowDelay()
setHelpTooltipShowDelay(
duration):void
Sets the duration in milliseconds before the help tooltip is shown. A value of null means the help tooltip will not be auto shown.
Parameters
duration
The duration in milliseconds before the help tooltip is shown. If null, tooltip won't be auto shown.
null | number
Returns
void
Throws
Throws an error if duration is less than or equal to 0 when not null.
setTimeoutDuration()
setTimeoutDuration(
duration,setHelpTooltipShowDelay?):void
Sets the duration after which the scanning session will timeout. The timeout can occur in various scenarios and may be restarted by different scanning events.
Parameters
duration
The timeout duration in milliseconds. If null, timeout won't be triggered ever.
null | number
setHelpTooltipShowDelay?
boolean
If true, also sets the help tooltip show delay to half of the provided duration. If timeout duration is null, help tooltip show delay will be set to null. Defaults to true.
Returns
void
Throws
Throws an error if duration is less than or equal to 0 when not null.