Optional
backgroundOptional
containerOptional
containerThe container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.
Optional
detectionOptional
extractVINFromIf true, the VIN scanner will also extract VINs from barcodes. Requires a license that allows barcode scanning in addition to VIN scanning.
false;
Optional
maximumMaximum number of accumulated frames to inspect before actual result is returned.
3;
Optional
minimumMinimum number of accumulated frames that have equal result.
2;
Optional
ocrMaximum image size (height or width) for OCR process. 0 - do not rescale.
0;
Optional
finderOptional
mirroredOptional
onError callback of the SDK. If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error.
Optional
onOptional
preferredCamera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.
Optional
spinnerOptional
userOptional
background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }The background style used for the user guidance.
new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorSurfaceLow"
});
Optional
title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }The title of the user guidance.
new StyledText({
"color": "?sbColorOnPrimary"
});
Optional
visible?: booleanDetermines whether the user guidance is visible or not.
true;
Optional
videoScanbotCameraView video constraints
Optional
zoomDigital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.
Static
DEFAULT_Static
DEFAULT_Static
DEFAULT_Static
DEFAULT_Static
DEFAULT_Static
fromStatic
mapStatic
mapStatic
mapGenerated using TypeDoc
The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.