Optional backgroundOptional captureOptional containerThe 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.
Optional 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 desiredIf set, limit the resolution of the image that is used for barcode recognition. A lower value will result in faster processing times but may reduce recognition quality.
Optional detectionOptional finderOptional aspectThe viewfinder's aspect ratio.
new AspectRatio({
"width": 1.0,
"height": 1.0
});
Optional overlayColor of the viewfinder overlay.
"?sbColorSurfaceLow";
Optional style?: ({ readonly _type?: "FinderCorneredStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) | ({ readonly _type?: "FinderStrokedStyle"; strokeColor?: string; strokeWidth?: number; cornerRadius?: number; })Visual appearance of the viewfinder.
new FinderCorneredStyle({
"strokeColor": "?sbColorSurface",
"strokeWidth": 2.0,
"cornerRadius": 10.0
});
Optional visible?: booleanWhether the viewfinder is visible.
true;
Optional mirroredOptional onOptional 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. You should dispose the scanner and use ScanbotSDK.destroy and ScanbotSDK.initialize to re-initialize the SDK.
Optional overlayOptional preferredCamera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.
Optional scanSpecial property to enable barcode count mode. This is a type of a ready-to-use user interface scanning and counting found barcodes. It can be configured via its 'style' (BarcodeCountStyleConfiguration) property. It returns results normally via 'onBarcodesDetected' callback. Please note that results are returned for each consecutive scan, not only after the last scan
Optional spinnerOptional userOptional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }Background style used for the user guidance.
new BackgroundStyle({
"strokeColor": "#00000000",
"fillColor": "?sbColorSurfaceLow"
});
Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }Title of the user guidance.
new StyledText({
"color": "?sbColorOnPrimary"
});
Optional visible?: booleanWhether the user guidance is visible.
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
Capture delay in milliseconds after detecting barcodes. Defaults to 1000