Optional autoOptional autoIf auto-capture is enabled and when a document is detected, it will be automatically captured when conditions are good and the auto-snapping time-out elapses.
Optional autoControls the auto-capture speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. The default value is 0.66 (2 seconds)
Optional backgroundOptional 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 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 ignoreDetermines whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default BadAspectRatio is not ignored.
Optional mirroredOptional onBy default, capture button invokes 'onDocumentDetected' callback, if you want custom behavior, you can optionally override this button
Optional onDocument detected callback. Continuous callback, stopped only when detection is stopped or camera widget is disposed.
Optional 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 preferredCamera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.
Optional spinnerOptional styleOptional textOptional useAttempts to take a single exposure using the video capture device, resulting in a high resolution image and potentially greatly improved detection quality. Relies on the experimental ImageCapture API that: https://developer.mozilla.org/en-US/docs/Web/API/ImageCapture. Use with caution. At the time of writing this, reliably only works on Android devices with Google Chrome. If enabled, this only affects extraction after the document outline has been identified. This may also trigger your device's default "snap" animation, making scanbotSDK.utils.flash(); irrelevant Defaults to false.
Optional videoScanbotCameraView video constraints
Static DEFAULT_Static DEFAULT_Static DEFAULT_Static DEFAULT_Static DEFAULT_Static fromStatic mapStatic mapGenerated using TypeDoc
Delay in milliseconds before the auto-capture is triggered after 'onDocumentDetected' has been called. This delay is used to prevent too many documents being captured in a row. In essence, autoCaptureSensitivity controls the speed of autocapture during the detection phase, while autoCaptureDelay controls the speed of autocapture after the detection phase. Default is 1000ms.