❤
npm
Sign UpSign In

capacitor-plugin-scanbot-sdk
TypeScript icon, indicating that this package has built-in type declarations

4.2.0 • Public • Published

Scanbot Document and Barcode Scanner SDK for Capacitor

Add enterprise-grade document and barcode scanning as well as data capture functionalities to your app in no time

The Scanbot Document and Barcode Scanner SDK for Capacitor enables you to easily implement scanning, document creation, and data extraction functionalities for your apps on iOS and Android.

Access the available cameras on the mobile device, choose the interface, configure the settings, and let your users easily scan any document, barcode, or other data in your application.

Benefit from advanced machine-learning based features like automatic scanning, perspective correction, user guidance, automated cropping, multiple export formats like PDF, TIFF, JPEG; blur detection, image filters, encryption, and much more...

Check out the demo.

Documentation & Example App

To integrate this module into your application please follow the steps in our documentation and check out our example app.

Changelog

For a detailed list of the changes included in each version, please see the changelog.

Trial License

The Scanbot SDK will run without a license for one minute per session! To get an unrestricted, "no-strings-attached" 7-day trial license, please submit the Trial License Form on our website. If you need more time to test our SDK, you can also submit our Proof of Concept Form – giving you a free trial period of 30 days.

Please kindly note that a trial license can only be used in a development and staging environment. You are not allowed to publish your app to the App Store, Play Store or any 3rd party Android App Store with a trial license.

Free Developer Support

We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please visit our Support Page.

Install

npm install capacitor-plugin-scanbot-sdk
npm run build
npx cap update ios
npx cap sync

API

startDocumentScanner(...)

startDocumentScanner(configuration: DocumentScannerConfiguration) => Promise<ResultWrapper<DocumentScannerResult>>
Param Type
configuration DocumentScannerConfiguration

Returns: Promise<ResultWrapper<DocumentScannerResult>>

closeDocumentScanner()

closeDocumentScanner() => Promise<void>

startFinderDocumentScanner(...)

startFinderDocumentScanner(configuration: FinderDocumentScannerConfiguration) => Promise<ResultWrapper<DocumentScannerResult>>
Param Type
configuration FinderDocumentScannerConfiguration

Returns: Promise<ResultWrapper<DocumentScannerResult>>

closeFinderDocumentScanner()

closeFinderDocumentScanner() => Promise<void>

startCroppingScreen(...)

startCroppingScreen(args: { page: Page; configuration: CroppingConfiguration; }) => Promise<ResultWrapper<CroppingResult>>
Param Type
args { page: Page; configuration: CroppingConfiguration; }

Returns: Promise<ResultWrapper<CroppingResult>>

closeCroppingScreen()

closeCroppingScreen() => Promise<void>

startMrzScanner(...)

startMrzScanner(configuration: MrzScannerConfiguration) => Promise<ResultWrapper<MrzScannerResult>>
Param Type
configuration MrzScannerConfiguration

Returns: Promise<ResultWrapper<MrzScannerResult>>

closeMrzScanner()

closeMrzScanner() => Promise<void>

startBarcodeScanner(...)

startBarcodeScanner(configuration: BarcodeScannerConfiguration) => Promise<ResultWrapper<BarcodeScannerResult>>
Param Type
configuration BarcodeScannerConfiguration

Returns: Promise<ResultWrapper<BarcodeScannerResult>>

closeBarcodeScanner()

closeBarcodeScanner() => Promise<void>

startBatchBarcodeScanner(...)

startBatchBarcodeScanner(configuration: BatchBarcodeScannerConfiguration) => Promise<ResultWrapper<BatchBarcodeScannerResult>>
Param Type
configuration BatchBarcodeScannerConfiguration

Returns: Promise<ResultWrapper<BatchBarcodeScannerResult>>

closeBatchBarcodeScanner()

closeBatchBarcodeScanner() => Promise<void>

startEHICScanner(...)

startEHICScanner(configuration: HealthInsuranceCardScannerConfiguration) => Promise<ResultWrapper<HealthInsuranceCardScannerResult>>
Param Type
configuration HealthInsuranceCardScannerConfiguration

Returns: Promise<ResultWrapper<HealthInsuranceCardScannerResult>>

closeEHICScanner()

closeEHICScanner() => Promise<void>

startTextDataScanner(...)

startTextDataScanner(configuration: TextDataScannerConfiguration) => Promise<ResultWrapper<TextDataScannerResult>>
Param Type
configuration TextDataScannerConfiguration

Returns: Promise<ResultWrapper<TextDataScannerResult>>

closeTextDataScanner()

closeTextDataScanner() => Promise<void>

startLicensePlateScanner(...)

startLicensePlateScanner(configuration: LicensePlateScannerConfiguration) => Promise<ResultWrapper<LicensePlateScannerResult>>
Param Type
configuration LicensePlateScannerConfiguration

Returns: Promise<ResultWrapper<LicensePlateScannerResult>>

closeLicensePlateScanner()

closeLicensePlateScanner() => Promise<void>

startMedicalCertificateRecognizer(...)

startMedicalCertificateRecognizer(configuration: MedicalCertificateRecognizerConfiguration) => Promise<ResultWrapper<MedicalCertificateRecognizerResult>>
Param Type
configuration MedicalCertificateRecognizerConfiguration

Returns: Promise<ResultWrapper<MedicalCertificateScannerResult>>

closeMedicalCertificateRecognizer()

closeMedicalCertificateRecognizer() => Promise<void>

startGenericDocumentRecognizer(...)

startGenericDocumentRecognizer(configuration: GenericDocumentRecognizerConfiguration) => Promise<ResultWrapper<GenericDocumentRecognizerResult>>
Param Type
configuration GenericDocumentRecognizerConfiguration

Returns: Promise<ResultWrapper<GenericDocumentRecognizerResult>>

closeGenericDocumentRecognizer()

closeGenericDocumentRecognizer() => Promise<void>

startCheckRecognizer(...)

startCheckRecognizer(configuration: CheckRecognizerConfiguration) => Promise<ResultWrapper<CheckRecognizerResult>>
Param Type
configuration CheckRecognizerConfiguration

Returns: Promise<ResultWrapper<CheckRecognizerResult>>

closeCheckRecognizer()

closeCheckRecognizer() => Promise<void>

startVinScanner(...)

startVinScanner(configuration: VinScannerConfiguration) => Promise<ResultWrapper<VinScannerResult>>
Param Type
configuration VinScannerConfiguration

Returns: Promise<ResultWrapper<VinScannerResult>>

closeVinScanner()

closeVinScanner() => Promise<void>

initializeSDK(...)

initializeSDK(options: ScanbotSdkConfiguration) => Promise<ResultWrapper<InitializeSDKResult>>

SDK Operations *

Param Type
options ScanbotSdkConfiguration

Returns: Promise<ResultWrapper<InitializeSDKResult>>

getLicenseInfo()

getLicenseInfo() => Promise<ResultWrapper<GetLicenseInfoResult>>

Returns: Promise<ResultWrapper<GetLicenseInfoResult>>

detectBarcodesOnImage(...)

detectBarcodesOnImage(args: DetectBarcodesOnImageArguments) => Promise<ResultWrapper<DetectBarcodesOnImageResult>>
Param Type
args DetectBarcodesOnImageArguments

Returns: Promise<ResultWrapper<DetectBarcodesOnImageResult>>

detectBarcodesOnImages(...)

detectBarcodesOnImages(args: DetectBarcodesOnImagesArguments) => Promise<ResultWrapper<DetectBarcodesOnImagesResult>>
Param Type
args DetectBarcodesOnImagesArguments

Returns: Promise<ResultWrapper<DetectBarcodesOnImagesResult>>

applyImageFilter(...)

applyImageFilter(args: { imageFileUri: string; filter: ImageFilterType; }) => Promise<ResultWrapper<ApplyImageFilterResult>>
Param Type
args { imageFileUri: string; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<ApplyImageFilterResult>>

applyImageFilterOnPage(...)

applyImageFilterOnPage(args: { page: Page; filter: ImageFilterType; }) => Promise<ResultWrapper<ApplyImageFilterOnPageResult>>
Param Type
args { page: Page; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<ApplyImageFilterOnPageResult>>

getImageData(...)

getImageData(args: { imageFileUri: string; }) => Promise<ResultWrapper<GetImageDataResult>>
Param Type
args { imageFileUri: string; }

Returns: Promise<ResultWrapper<GetImageDataResult>>

rotateImage(...)

rotateImage(args: { imageFileUri: string; degrees: number; }) => Promise<ResultWrapper<RotateImageResult>>
Param Type
args { imageFileUri: string; degrees: number; }

Returns: Promise<ResultWrapper<RotateImageResult>>

createPage(...)

createPage(args: { imageUri: string; }) => Promise<ResultWrapper<CreatePageResult>>
Param Type
args { imageUri: string; }

Returns: Promise<ResultWrapper<CreatePageResult>>

removePage(...)

removePage(args: { page: Page; }) => Promise<ResultWrapper<RemovePageResult>>
Param Type
args { page: Page; }

Returns: Promise<ResultWrapper<RemovePageResult>>

rotatePage(...)

rotatePage(args: { page: Page; times: number; }) => Promise<ResultWrapper<RotatePageResult>>
Param Type
args { page: Page; times: number; }

Returns: Promise<ResultWrapper<RotatePageResult>>

setDocumentImage(...)

setDocumentImage(args: { page: Page; imageFileUri: string; }) => Promise<ResultWrapper<SetDocumentImageResult>>
Param Type
args { page: Page; imageFileUri: string; }

Returns: Promise<ResultWrapper<SetDocumentImageResult>>

detectDocument(...)

detectDocument(args: { imageFileUri: string; }) => Promise<ResultWrapper<DetectDocumentResult>>
Param Type
args { imageFileUri: string; }

Returns: Promise<ResultWrapper<DetectDocumentResult>>

detectDocumentOnPage(...)

detectDocumentOnPage(args: { page: Page; }) => Promise<ResultWrapper<DetectDocumentOnPageResult>>
Param Type
args { page: Page; }

Returns: Promise<ResultWrapper<DetectDocumentOnPageResult>>

documentQualityAnalyzer(...)

documentQualityAnalyzer(args: { imageFileUri: string; imageSizeLimit?: number; }) => Promise<ResultWrapper<DocumentQualityAnalyzerResult>>
Param Type
args { imageFileUri: string; imageSizeLimit?: number; }

Returns: Promise<ResultWrapper<DocumentQualityAnalyzerResult>>

extractImagesFromPdf(...)

extractImagesFromPdf(args: ExtractImagesFromPdfArguments) => Promise<ResultWrapper<ExtractImagesFromPdfResult>>
Param Type
args ExtractImagesFromPdfArguments

Returns: Promise<ResultWrapper<ExtractImagesFromPdfResult>>

extractPagesFromPdf(...)

extractPagesFromPdf(args: ExtractPagesFromPdfArguments) => Promise<ResultWrapper<ExtractPagesFromPdfResult>>
Param Type
args ExtractPagesFromPdfArguments

Returns: Promise<ResultWrapper<ExtractPagesFromPdfResult>>

recognizeCheck(...)

recognizeCheck(args: { imageFileUri: string; acceptedCheckStandards?: CheckStandard[]; }) => Promise<ResultWrapper<RecognizeCheckResult>>
Param Type
args { imageFileUri: string; acceptedCheckStandards?: CheckStandard[]; }

Returns: Promise<ResultWrapper<RecognizeCheckResult>>

recognizeMrz(...)

recognizeMrz(args: { imageFileUri: string; }) => Promise<ResultWrapper<RecognizeMRZResult>>
Param Type
args { imageFileUri: string; }

Returns: Promise<ResultWrapper<RecognizeMRZResult>>

refreshImageUris(...)

refreshImageUris(args: { pages: Page[]; }) => Promise<ResultWrapper<RefreshImageUrisResult>>
Param Type
args { pages: Page[]; }

Returns: Promise<ResultWrapper<RefreshImageUrisResult>>

getOCRConfigs()

getOCRConfigs() => Promise<ResultWrapper<GetOCRConfigsResult>>

Returns: Promise<ResultWrapper<GetOCRConfigsResult>>

cleanup()

cleanup() => Promise<ResultWrapper<void>>

Returns: Promise<ResultWrapper<void>>

getFilteredDocumentPreviewUri(...)

getFilteredDocumentPreviewUri(args: { page: Page; filter: ImageFilterType; }) => Promise<ResultWrapper<GetFilteredDocumentPreviewUriResult>>
Param Type
args { page: Page; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<GetFilteredDocumentPreviewUriResult>>

performOCR(...)

performOCR(args: PerformOCRArguments) => Promise<ResultWrapper<PerformOCRResult>>
Param Type
args PerformOCRArguments

Returns: Promise<ResultWrapper<PerformOCRResult>>

createPDF(...)

createPDF(args: CreatePDFArguments) => Promise<ResultWrapper<CreatePDFResult>>
Param Type
args CreatePDFArguments

Returns: Promise<ResultWrapper<CreatePDFResult>>

writeTIFF(...)

writeTIFF(args: WriteTIFFArguments) => Promise<ResultWrapper<WriteTIFFResult>>
Param Type
args WriteTIFFArguments

Returns: Promise<ResultWrapper<WriteTIFFResult>>

Interfaces

DocumentScannerResult

Prop Type Description
pages Page[] The array of scanned pages

Page

SDK Page

Prop Type Description
pageId string A string identifying the page in the internal page file storage
polygon PolygonPoint[] The page's cropping polygon as calculated by a document detection operation or as set by the cropping UI. Modifying the polygon will change the polygon as shown in the cropping UI but will not automatically re-crop the original image
detectionResult DetectionStatus The document detection result status for the operation that produced the page
pageImageSource PageImageSource The image source
filter ImageFilterType The Image Filter that was applied on the page image
documentImageSizeLimit Size The value that was set for documentImageSizeLimit, which limits the maximum size of the document image.
originalImageFileUri string File URI of the original image
documentImageFileUri string File URI of the cropped document image (if document detection was successful)
originalPreviewImageFileUri string File URI of a screen-sized preview of the original image
documentPreviewImageFileUri string File URI of a screen-sized preview of the document image (if document detection was successful)

PolygonPoint

Polygon Point

Prop Type Description
x number Polygon point X
y number Polygon point Y

Size

Standard size object

Prop Type Description
width number Width parameter
height number Height parameter

DocumentScannerConfiguration

Prop Type Description
acceptedAngleScore number The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0.
acceptedSizeScore number The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
autoSnappingButtonHidden boolean Controls whether the auto-snapping toggle button is hidden or not.
autoSnappingButtonTitle string Title of the auto-snapping toggle button.
autoSnappingEnabled boolean When auto-snapping is enabled the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode the user can still tap the shutter button to snap a document.
autoSnappingSensitivity number Controls the auto-snapping 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)
autoSnappingDelay number The minimum delay in seconds between two consecutive automatic image captures. iOS only.
bottomBarBackgroundColor string The background color of the bottom shutter-bar.
bottomBarButtonsColor string The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
cameraModule CameraModule The preferred camera module (default - BACK)
cameraBackgroundColor string The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
cameraPreviewMode CameraPreviewMode Preview mode of the camera. Fit-In or Fill-In.
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
cameraUnavailableExplanationText string String being displayed on the label describing that the app is in split mode and needs to go fullscreen to work with camera. iOS only.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle string Title of the cancel button.
defaultPageFilter ImageFilterType The default image filter type for new documents pages. Defaults to ImageFilterTypeNone.
detectorMode DocumentDetectorMode The mode of the document detector to be used for document outline detection. Defaults to ML_BASED. iOS only. For Android, use the Scanbot SDK initializer.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not.
flashButtonTitle string Title of the flash toggle button.
flashEnabled boolean Controls whether the flash should be initially enabled. The default value is FALSE.
forceUserGuidance boolean Shows the user guidance elements if autosnapping is disabled.
ignoreBadAspectRatio boolean Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default BadAspectRatio is not ignored.
imageScale number The image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
multiPageButtonHidden boolean Controls whether the multi-page toggle button is hidden or not.
multiPageButtonTitle string Title of the multi-page mode toggle button.
multiPageEnabled boolean Controls multi-page mode. When enabled, the user can take multiple document photos before closing the screen by tapping the page counter button. When disabled, the screen will be closed immediately after the first document photo is made. The default value is FALSE.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
pageCounterButtonTitle string Title suffix of the button that finishes the document scanning when multi-page scanning is enabled. The button's title has the format "# Pages", where '#' shows the number of images captured up to now and the suffix "Pages" is set using this method.
photoQualityPrioritization CapturePhotoQualityPrioritization The prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: Has no effect on devices prior to iOS 13.0!. iOS only.
polygonBackgroundColor string The background color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
polygonBackgroundColorOK string The background color of the detected document outline when we are ready to snap OK.
polygonColor string The color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix).
polygonColorOK string The color of the detected document outline when we are ready to snap OK.
polygonLineWidth number Width of the detected document outline.
polygonCornerRadius number The radius to use when drawing rounded corners of the polygon. Default is 8.0.
polygonAutoSnapProgressColor string Stroke color of polygon auto snap progress animation. Default is green. Can't be nil.
polygonAutoSnapProgressLineWidth number Line width of polygon auto snap progress animation. Default is 5.0.
polygonAutoSnapProgressEnabled boolean Whether polygon auto snap progress animation is enabled or not. Default is true.
requiredAspectRatios AspectRatio[] An optional array of aspect ratios the documents have to conform to.
preferredAspectRatios AspectRatio[] An optional array of aspect ratios the documents may conform to.
shutterButtonAutoInnerColor string Whether polygon auto snap progress animation is enabled or not. Default is true.
shutterButtonAutoOuterColor string The background color of the shutter button in auto-snapping mode.
shutterButtonIndicatorColor string The indicator color of the shutter button in auto-snapping mode. iOS only.
shutterButtonManualInnerColor string The foreground color of the shutter button in manual mode.
shutterButtonManualOuterColor string The background color of the shutter button in manual mode.
stopsCameraSessionWhenDisappeared boolean The camera session will be stopped entirely, when the receiver disappears and restarts when the receiver reappears if set to True else will pause the delivery of video frames and QR Codes. Defaults to True. iOS only.
textHintBadAngles string Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES
textHintBadAspectRatio string Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO
textHintNothingDetected string Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED
textHintOffCenter string The text being displayed on the user-guidance label, when a document was detected, but its center is too far away from the image center.
textHintOK string Text hint that will be shown when the current detection status is OK
textHintTooDark string Text hint that will be shown when the current detection status is ERROR_TOO_DARK
textHintTooNoisy string Text hint that will be shown when the current detection status is ERROR_TOO_NOISY
textHintTooSmall string Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor string The color of all inactive toggle buttons in the toolbar.
userGuidanceBackgroundColor string The background color of the user guidance hints.
userGuidanceTextColor string The text color of the user guidance hints.
userGuidanceFontSize number Font size of the user guidance. Default is 17.0.
documentImageSizeLimit Size Limits the maximum size of the document image. If width or height are zero, this property is effectively ignored.
shutterButtonHidden boolean Hides the shutter button if set to TRUE. Shows it otherwise. Defaults to FALSE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.
textHintEnergySavingActive string The text being displayed on the user-guidance label, when the scanners energy saver is activated. iOS only.
maxNumberOfPages number Maximum number of pages to scan. Ignored when set to null, or when multiPageEnabled is FALSE. Default value is null.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
accessibilityConfiguration DocumentScannerAccessibilityConfiguration Allows you to customize the accessibility configuration for the Document Scanner UI

AspectRatio

Finder aspect ratio

Prop Type Description
width number The width component of the aspect ratio.
height number The height component of the aspect ratio.

DocumentScannerAccessibilityConfiguration

Document scanner accessibility configuration

Prop Type Description
flashButtonAccessibilityLabel string Text, that is used as an accessibility label for the flash button.
flashButtonAccessibilityHint string Text, that is used as an accessibility hint for the flash button.
multiPageButtonAccessibilityLabel string Text, that is used as an accessibility label for the multi-page button.
multiPageButtonAccessibilityHint string Text, that is used as an accessibility hint for the multi-page button.
autoSnappingButtonAccessibilityLabel string Text, that is used as an accessibility label for the auto-snapping button.
autoSnappingButtonAccessibilityHint string Text, that is used as an accessibility hint for the auto-snapping button.
cancelButtonAccessibilityLabel string Text, that is used as an accessibility label for the cancel button.
cancelButtonAccessibilityHint string Text, that is used as an accessibility hint for the cancel button.
pageCounterButtonAccessibilityLabel string Text, that is used as an accessibility label for the page-amount button.
pageCounterAccessibilityHint string Text, that is used as an accessibility hint for the page-amount button.
shutterButtonAccessibilityLabel string Text, that is used as an accessibility label for the shutter button.
shutterButtonAccessibilityHint string Text, that is used as an accessibility hint for the shutter button.

FinderDocumentScannerConfiguration

Prop Type Description
acceptedAngleScore number The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0.
acceptedSizeScore number The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
autoSnappingEnabled boolean When auto-snapping is enabled the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode the user can still tap the shutter button to snap a document.
autoSnappingSensitivity number Controls the auto-snapping 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)
autoSnappingDelay number The minimum delay in seconds between two consecutive automatic image captures. iOS only.
cameraModule CameraModule The preferred camera module (default - BACK)
cameraBackgroundColor string The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
cameraPreviewMode CameraPreviewMode Preview mode of the camera. Fit-In or Fill-In.
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
cameraUnavailableExplanationText string String being displayed on the label describing that the app is in split mode and needs to go fullscreen to work with camera. iOS only.
cancelButtonTitle string Title of the cancel button.
defaultPageFilter ImageFilterType The default image filter type for new documents pages. Defaults to ImageFilterTypeNone.
detectorMode DocumentDetectorMode The mode of the document detector to be used for document outline detection. Defaults to ML_BASED. iOS only. For Android, use the Scanbot SDK initializer.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not.
flashEnabled boolean Controls whether the flash should be initially enabled. The default value is FALSE.
forceUserGuidance boolean Shows the user guidance elements if autosnapping is disabled.
finderEnabled boolean Enables the view finder.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
cameraOverlayColor string Background color outside of the finder window.
finderAspectRatio AspectRatio Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is the DIN A4 aspect ratio.
ignoreBadAspectRatio boolean Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default BadAspectRatio is not ignored.
imageScale number The image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
photoQualityPrioritization CapturePhotoQualityPrioritization The prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: Has no effect on devices prior to iOS 13.0!.
polygonEnabled boolean Enables the displaying of the documents polygon.
polygonBackgroundColor string The background color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
polygonBackgroundColorOK string The background color of the detected document outline when we are ready to snap OK.
polygonColor string The color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix).
polygonColorOK string The color of the detected document outline when we are ready to snap OK.
polygonLineWidth number Width of the detected document outline.
polygonCornerRadius number The radius to use when drawing rounded corners of the polygon. Default is 8.0.
autoSnapProgressColor string Stroke color of polygon or finder auto snap progress animation. Default is green. Can't be nil.
autoSnapProgressLineWidth number Line width of polygon or finder auto snap progress animation. Default is 5.0.
autoSnapProgressEnabled boolean Whether polygon or finder auto snap progress animation is enabled or not. Default is true.
lockDocumentAspectRatioToFinder boolean If true allows only scanning of documents with the aspect ratio that the finder has.
shutterButtonAutoInnerColor string Whether polygon auto snap progress animation is enabled or not. Default is true.
shutterButtonAutoOuterColor string The background color of the shutter button in auto-snapping mode.
shutterButtonIndicatorColor string The indicator color of the shutter button in auto-snapping mode. iOS only.
shutterButtonManualInnerColor string The foreground color of the shutter button in manual mode.
shutterButtonManualOuterColor string The background color of the shutter button in manual mode.
stopsCameraSessionWhenDisappeared boolean The camera session will be stopped entirely, when the receiver disappears and restarts when the receiver reappears if set to True else will pause the delivery of video frames and QR Codes. Defaults to True. iOS only.
textHintBadAngles string Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES
textHintBadAspectRatio string Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO
textHintNothingDetected string Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED
textHintOffCenter string The text being displayed on the user-guidance label, when a document was detected, but its center is too far away from the image center.
textHintOK string Text hint that will be shown when the current detection status is OK
textHintTooDark string Text hint that will be shown when the current detection status is ERROR_TOO_DARK
textHintTooNoisy string Text hint that will be shown when the current detection status is ERROR_TOO_NOISY
textHintTooSmall string Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor string The color of all inactive toggle buttons in the toolbar.
userGuidanceBackgroundColor string The background color of the user guidance hints.
userGuidanceTextColor string The text color of the user guidance hints.
userGuidanceFontSize number Font size of the user guidance. Default is 17.0.
documentImageSizeLimit Size Limits the maximum size of the document image. If width or height are zero, this property is effectively ignored.
shutterButtonHidden boolean Hides the shutter button if set to TRUE. Shows it otherwise. Defaults to TRUE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.
textHintEnergySavingActive string The text being displayed on the user-guidance label, when the scanners energy saver is activated. iOS only.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
accessibilityConfiguration FinderDocumentScannerAccessibilityConfiguration Allows you to customize the accessibility configuration for the Document Scanner UI

FinderDocumentScannerAccessibilityConfiguration

Finder Document scanner accessibility configuration

Prop Type Description
flashButtonAccessibilityLabel string Text, that is used as an accessibility label for the flash button.
flashButtonAccessibilityHint string Text, that is used as an accessibility hint for the flash button.
cancelButtonAccessibilityLabel string Text, that is used as an accessibility label for the cancel button.
cancelButtonAccessibilityHint string Text, that is used as an accessibility hint for the cancel button.
shutterButtonAccessibilityLabel string Text, that is used as an accessibility label for the shutter button.
shutterButtonAccessibilityHint string Text, that is used as an accessibility hint for the shutter button.

CroppingResult

Prop Type Description
page Page The cropped page

CroppingConfiguration

Prop Type Description
cancelButtonTitle string Title of the cancel button.
hintTitle string Text of the edit screen hint.
hintTitleColor string Color of the edit screen hint text.
backgroundColor string Background color of the screen.
rotateButtonTitle string Title of the Rotate button.
resetButtonTitle string Title of the Reset button.
detectButtonTitle string Title of the Detect button.
doneButtonTitle string Title of the Done button.
rotateButtonHidden boolean Changes the visibility of the Rotate button.
detectResetButtonHidden boolean Changes the visibility of Detect and Reset buttons.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
polygonColor string Default color of the cropping outline.
anchorPointsColor string Default color of the cropping draggable elements.
polygonColorMagnetic string Outline color of magnetically snapped edges.
polygonLineWidth number Width of the detected document outline.
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
bottomBarBackgroundColor string The background color of the bottom shutter-bar.
bottomBarButtonsColor string The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
swapTopBottomButtons boolean Swap top and bottom buttons on the screen
topBarTitle string The title of the Cropping UI Screen. iOS only
topBarTitleColor string The color of the title. iOS only
accessibilityConfiguration CroppingAccessibilityConfiguration Allows you to customize the accessibility configuration for the Cropping UI

CroppingAccessibilityConfiguration

Cropping screen accessibility configuration

Prop Type Description
cancelButtonAccessibilityLabel string Text, that is used as an accessibility label for the cancel button
cancelButtonAccessibilityHint string Text, that is used as an accessibility hint for the cancel button
doneButtonAccessibilityLabel string Text, that is used as an accessibility label for the done button
doneButtonAccessibilityHint string Text, that is used as an accessibility hint for the done button.
detectButtonAccessibilityLabel string Text, that is used as an accessibility label for the detect button
detectButtonAccessibilityHint string Text, that is used as an accessibility hint for the detect button
resetButtonAccessibilityLabel string Text, that is used as an accessibility label for the reset button
resetButtonAccessibilityHint string Text, that is used as an accessibility hint for the reset button
rotateButtonAccessibilityLabel string Text, that is used as an accessibility hint for the rotate button
rotateButtonAccessibilityHint string Text, that is used as an accessibility hint for the rotate button

MrzScannerResult

MrzScannerConfiguration

Prop Type Description
cameraModule CameraModule The preferred camera module (default - BACK)
cameraOverlayColor string Background color outside of the finder window.
cancelButtonTitle string Title of the cancel button.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
finderTextHint string String being displayed as description.
finderTextHintColor string Foreground color of the description label.
finderAspectRatio AspectRatio Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 7 - which is good for standard machine readable zones.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle string Title of the flash toggle button. iOS only.
flashEnabled boolean Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
successBeepEnabled boolean Controls whether to play a beep sound after a successful detection. Default value is TRUE.
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor string The color of all inactive toggle buttons in the toolbar.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon boolean If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode CameraPreviewMode Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

BarcodeScannerResult

Prop Type Description
barcodes BarcodeResultField[] The array of detected barcodes

BarcodeResultField

The Barcode Scanner Result Field

Prop Type Description
type BarcodeFormat The recognized barcode type
text string The recognized barcode text
textWithExtension string The recognized barcode text with extension (if available)
rawBytes number[] The array of raw bytes that compose the recognized barcode
parsedSuccessful boolean True if the Barcode Document has been parsed successfully
formattedResult AAMVADocumentFormat | BoardingPassDocumentFormat | GS1DocumentFormat | IDCardPDF417DocumentFormat | MedicalCertificateDocumentFormat | MedicalPlanDocumentFormat | SEPADocumentFormat | SwissQRCodeDocumentFormat | VCardDocumentFormat The formatted barcode document (if it was parsed succesfully)

AAMVADocumentFormat

AAMVA Document Format

Prop Type Description
headerRawString string Header Raw String
fileType string File Type
issuerIdentificationNumber string Issuer Identification Number
aamvaVersionNumber string AAMVA Version Number
jurisdictionVersionNumber string Jurisdiction Version Number
numberOfEntries number Number of entries
subfiles AAMVADocumentSubfile[] Sub-files

AAMVADocumentSubfile

AAMVA Document Sub-File

Prop Type Description
subFileType string Sub-file type
subFileRawHeader string Sub-file raw header
fields AAMVADocumentSubfileField[] Sub-file fields

AAMVADocumentSubfileField

AAMVA Document Sub-File Field

Prop Type Description
type AAMVARecordFieldType AAMVA Document sub-file Record Field Type
typeString string AAMVA Document sub-file Field Type String
value string AAMVA Document sub-file Field value
rawValue string AAMVA Document sub-file Field raw value

BoardingPassDocumentFormat

Boarding Pass Document Format

Prop Type Description
numberOfLegs number Number of legs
electronicTicket boolean True if electronic ticket, false otherwise
securityData string Security Data
legs BoardingPassLeg[] Legs

BoardingPassLeg

Boarding Pass Leg

Prop Type Description
fields BoardingPassLegField[] Boarding Pass Leg Fields

BoardingPassLegField

Boarding Pass Leg Field

Prop Type Description
type BoardingPassDocumentFieldType Boarding Pass Document Field Type
value string Boarding Pass Document Field Value

GS1DocumentFormat

GS1 Document Format

Prop Type Description
fields GS1DocumentField[] GS1 Document fields

GS1DocumentField

GS1 Document Field

Prop Type Description
rawValue string Field raw value
applicationIdentifier string Application Identifier
dataTitle string Data Title
fieldDescription string Field description
standard boolean True if it is standard, false otherwise
validationStatus GS1SystemElementValidationStatus Validation Status

IDCardPDF417DocumentFormat

ID Card PDF417 Document Format

Prop Type Description
fields IDCardPDF417DocumentField[] ID Card PDF417 Document Fields

IDCardPDF417DocumentField

ID Card PDF417 Document Field

Prop Type Description
type IDCardPDF417DocumentFieldType Field Type
value string Field Value

MedicalCertificateDocumentFormat

Medical Certificate Document Format

Prop Type Description
fields MedicalCertificateDocumentField[] Medical Certificate Document Fields

MedicalCertificateDocumentField

Medical Certificate Document Field

Prop Type Description
type MedicalCertificateDocumentFieldType Medical Certificate Document Field Type
value string Medical Certificate Document Field Value

MedicalPlanDocumentFormat

Medical Plan Document Format

Prop Type Description
GUID string Identifier
currentPage number Current page (index)
totalNumberOfPages number Total number of pages
documentVersionNumber string Document version number
patchVersionNumber string Patch version number
languageCountryCode string Language country code
patient MedicalPlanPatientInformation Patient Information
doctor MedicalPlanDoctorInformation Doctor Information
subheadings MedicalPlanStandardSubheading[] Subheadings

MedicalPlanPatientInformation

Medical Plan Patient Information

Prop Type Description
fields MedicalPlanPatientField[] Medical Plan Patient Fields

MedicalPlanPatientField

Medical Plan Patient Field

Prop Type Description
type MedicalPlanPatientFieldType Medical Plan Patient Field Type
value string Medical Plan Patient Field Value

MedicalPlanDoctorInformation

Medical Plan Doctor Information

Prop Type Description
fields MedicalPlanDoctorField[] Medical Plan Doctor Information Fields

MedicalPlanDoctorField

Medical Plan Doctor Field

Prop Type Description
type MedicalPlanDoctorFieldType Medical Plan Doctor Field Type
value string Medical Plan Doctor Field Value

MedicalPlanStandardSubheading

Medical Plan Standard Subheading

Prop Type Description
fields MedicalPlanStandardSubheadingField[] Subheading Fields
generalNotes string[] General Notes
medicines MedicalPlanMedicine[] Medicines
prescriptions MedicalPlanPrescription[] Prescriptions

MedicalPlanStandardSubheadingField

Medical Plan Standard Subheading Field

Prop Type Description
type MedicalPlanStandardSubheadingFieldType Medical Plan Standard Subheading Field Type
value string Medical Plan Standard Subheading Field Value

MedicalPlanMedicine

Medical Plan Medicine

Prop Type Description
fields MedicalPlanMedicineField[] Medical Plan Medicine Fields
substances MedicalPlanMedicineSubstance[] Medical Plan Medicine Substances

MedicalPlanMedicineField

Medical Plan Medicine Field

Prop Type Description
type MedicalPlanMedicineFieldType Medical Plan Medicine Field Type
value string Medical Plan Medicine Field Value

MedicalPlanMedicineSubstance

Medical Plan Medicine Substance

Prop Type Description
fields MedicalPlanMedicineSubstanceField[] Medical Plan Medicine Substance Fields

MedicalPlanMedicineSubstanceField

Medical Plan Medicine Substance Field

Prop Type Description
type MedicalPlanMedicineSubstanceFieldType Medical Plan Medicine Substance Field Type
value string Medical Plan Medicine Substance Field Value

MedicalPlanPrescription

Medical Plan Prescription

Prop Type Description
fields MedicalPlanPrescriptionField[] Medical Plan Prescription Fields

MedicalPlanPrescriptionField

Medical Plan Prescription Field

Prop Type Description
type MedicalPlanPrescriptionFieldType Medical Plan Prescription Field Type
value string Medical Plan Prescription Field Value

SEPADocumentFormat

SEPA Document Format

Prop Type Description
fields SEPADocumentFormatField[] SEPA Document Format Fields

SEPADocumentFormatField

SEPA Document Format Field

Prop Type Description
type SEPADocumentFieldType SEPA Document Field Type
value string SEPA Document Field Value

SwissQRCodeDocumentFormat

Swiss QR Code Document Format

Prop Type Description
fields SwissQRCodeDocumentField[] Swiss QR Code Document Fields
version SwissQRCodeVersion Swiss QR Code Version

SwissQRCodeDocumentField

Swiss QR Code Document Field

Prop Type Description
type SwissQRCodeDocumentFieldType Swiss QR Code Document Field Type
value string Swiss QR Code Document Field Value
typeHumanReadableString string Swiss QR Code Document Field Human-readable String

VCardDocumentFormat

vCard Document Format

Prop Type Description
fields VCardDocumentFormatField[] vCard Document Format Fields

VCardDocumentFormatField

vCard Document Field

Prop Type Description
type VCardDocumentFormatFieldType vCard Document Field Type
typeModifiers string[] vCard Document Field Type Modifiers
rawText string vCard Document Field Raw Text
values string[] vCard Document Field Values

BarcodeScannerConfiguration

Prop Type Description
acceptedDocumentFormats BarcodeDocumentFormat[] An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
barcodesExtensionFilter BarcodesExtensionFilter The extension filter for EAN and UPC barcodes.
barcodeValueFilter string Filter barcodes results by regular expression. To accept scanned barcode, regular expression should match the entire barcode value. By default, no filter is applied
cameraOverlayColor string Background color of the detection overlay.
cameraModule CameraModule Background color of the detection overlay.
cameraZoomFactor number The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle string String being displayed on the cancel button.
engineMode EngineMode The engine mode to be used for barcode scanning. The default value is NEXT_GEN.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
finderTextHint string String being displayed as description.
finderTextHintColor string Foreground color of the description label.
finderAspectRatio AspectRatio Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle string String being displayed on the flash button. iOS only.
flashButtonInactiveColor string Foreground color of the flash button when flash is off.
flashEnabled boolean Whether flash is toggled on or off.
focusLockEnabled boolean Disables auto-focus and locks the lens at the specified focus lock lens position. Default value is false. iOS only. For Android, minFocusDistanceLock can be used.
focusLockPosition number The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The default value is 0.0 iOS only. For Android, minFocusDistanceLock can be used.
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
minimumTextLength number Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
maximumTextLength number Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
minFocusDistanceLock boolean Lock focus distance withing minimum possible range
minimum1DBarcodesQuietZone number Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
stripCheckDigits boolean With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
successBeepEnabled boolean Whether scanner screen should make a sound on successful barcode or MRZ detection.
topBarBackgroundColor string Background color of the top bar.
topBarButtonsColor string Foreground color of the cancel button.
barcodeFormats BarcodeFormat[] Accepted barcode formats
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon boolean If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode CameraPreviewMode Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
cameraZoomRange ZoomRange The range of valid camera zoom factors. Default value is (1.0; 12.0).
autoCancelTimeout number Sets auto close timer in seconds. 0 = disabled and it is the default value.
gs1HandlingMode Gs1HandlingMode The GS1 handling mode. The default value is PARSE.
msiPlesseyChecksumAlgorithm MSIPlesseyChecksumAlgorithm The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
lowPowerMode boolean If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
codeDensity CodeDensity The expected density of QR codes in an image.
initialScanDelay number Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
delayAfterScan number Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
doubleTapToZoomEnabled boolean When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
pinchToZoomEnabled boolean When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only.
shouldAnimateZooming boolean Defines, if zooming in or out should be animated. iOS only.
viewFinderEnabled boolean Display the region of interest. The default value is TRUE.
confirmationDialogConfiguration ConfirmationDialogConfiguration The confirmation dialog configuration.
overlayConfiguration SelectionOverlayConfiguration The selection overlay configuration.

ZoomRange

Defines a range for zooming

Prop Type Description
minZoom number The minimum zoom scale. Defaults to 1.0.
maxZoom number The maximum zoom scale. Defaults to 12.0.

ConfirmationDialogConfiguration

Confirmation Dialog configuration

Prop Type Description
resultWithConfirmationEnabled boolean Defines, if the confirmation dialog should be displayed or not before returing the results to the delegate. Defaults to False.
dialogTextFormat BarcodeDialogFormat The text format of the result dialog. Defaults to TYPE_AND_CODE.
confirmationDialogStyle DialogStyle The style of the confirmation dialog. iOS only.
confirmButtonTitle string The title of the confirmation dialog confirm button.
confirmationDialogConfirmButtonStyle DialogButtonStyle The style of the confirmation dialogs confirm button. iOS only.
retryButtonTitle string The title of the confirmation dialog retry button.
confirmationDialogRetryButtonStyle DialogButtonStyle The style of the confirmation dialogs retry button. iOS only.
dialogTitle string The title of the confirmation dialog.
dialogMessage string The message text of the confirmation dialog.
dialogButtonsAccentColor string The accent color of buttons on a confirmation dialog. Android only.
confirmButtonFilled boolean Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
confirmButtonFilledTextColor string Allows to set a text color of the filled button. See confirmationDialogConfirmButtonFilled. Android only.

DialogStyle

Configuration for the dialog/alert style

Prop Type Description
screenBackgroundColor string The Color of the screen-covering backdrop view.
dialogBackgroundColor string The general background color of the actual dialog view.
dialogBackgroundEffect BlurEffect The visual effect of the dialogs background.
cornerRadius number The corner radius of the dialog.
titleColor string The color of the dialogs title.
titleFont Font The font of the dialogs title
messageColor string The color of the dialogs message.
messageFont Font The font of the dialogs message.
separatorColor string The color of the separators around the dialogs button area.
separatorWidth number The width of the separators in points.

Font

The font name and size. iOS only.

Prop Type Description
fontName string The font name. defaults to SYSTEM.
fontSize number The font size. defaults 17.0 .

DialogButtonStyle

Configuration for the dialogs/alerts OK button style.

Prop Type Description
font Font The font of the button title.
textColor string The color of the buttons title while not pressed.
highlightedTextColor string The color of the buttons title while pressed.
backgroundColor string The background color of the button while not pressed.
highlightedBackgroundColor string The background color of the button while pressed.

SelectionOverlayConfiguration

Barcode Selection Overlay configuration

Prop Type Description
overlayEnabled boolean Whether the barcode selection overlay is enabled or not.
automaticSelectionEnabled boolean Whether the barcode is selected automatically when being detected or not.
textFormat BarcodeOverlayTextFormat Define the way of how to show barcode data with selection overlay.
polygonColor string The color of the polygon in the selection overlay.
textColor string The color of the text in the selection overlay.
textContainerColor string The color of the texts background in the selection overlay.
highlightedPolygonColor string The color of the polygon in the selection overlay, when highlighted.
highlightedTextColor string The color of the text in the selection overlay, when highlighted.
highlightedTextContainerColor string The color of the texts background in the selection overlay, when highlighted.

BatchBarcodeScannerResult

BatchBarcodeScannerConfiguration

Prop Type Description
acceptedDocumentFormats BarcodeDocumentFormat[] An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
barcodesExtensionFilter BarcodesExtensionFilter The extension filter for EAN and UPC barcodes.
barcodeValueFilter string Filter barcodes results by regular expression. To accept scanned barcode, regular expression should match the entire barcode value. By default, no filter is applied
cameraOverlayColor string Background color of the detection overlay.
cameraModule CameraModule Background color of the detection overlay.
cameraZoomFactor number The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. The default value is 0.
cameraZoomRange ZoomRange The range of valid camera zoom factors. Default value is (0.0; 12.0). iOS only.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle string String being displayed on the cancel button.
doubleTapToZoomEnabled boolean When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
pinchToZoomEnabled boolean When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only.
shouldAnimateZooming boolean Defines, if zooming in or out should be animated. iOS only.
engineMode EngineMode String being displayed on the cancel button.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
finderTextHint string String being displayed as description.
finderTextHintColor string Foreground color of the description label.
finderAspectRatio AspectRatio Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle string String being displayed on the flash button. iOS only.
flashEnabled boolean Whether flash is toggled on or off.
focusLockEnabled boolean Disables auto-focus and locks the lens at the specified focus lock lens position. The default value is false. iOS only.
focusLockPosition number The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The default value is 0.0 iOS only. For Android, minFocusDistanceLock can be used.
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
minimumTextLength number Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
maximumTextLength number Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
minimum1DBarcodesQuietZone number Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
minFocusDistanceLock boolean Lock focus distance withing minimum possible range
stripCheckDigits boolean With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
successBeepEnabled boolean Whether scanner screen should make a sound on successful barcode or MRZ detection.
topBarBackgroundColor string Background color of the top bar.
topBarButtonsColor string Foreground color of the cancel button.
topBarButtonsInactiveColor string Foreground color of the top bar buttons when disabled.
barcodeFormats BarcodeFormat[] Accepted barcode formats
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
gs1HandlingMode Gs1HandlingMode The GS1 handling mode. The default value is PARSE.
msiPlesseyChecksumAlgorithm MSIPlesseyChecksumAlgorithm The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
lowPowerMode boolean If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
barcodesCountText string The color for barcodes count text
barcodesCountTextColor string The color for barcodes count text
clearButtonTitle string Text of the button which clears the list of scanned barcodes.
detailsActionColor string The color of Submit button
detailsBackgroundColor string The color of bottom sheet
detailsPrimaryColor string The color of text elements in bottom sheet
deleteButtonTitle string String being displayed on the delete button. iOS only.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
fetchingStateText string The text for the data fetching state of the barcode item in a list. Smth "Fetching info…"
noBarcodesTitle string Text of the message that there are no barcodes scanned
submitButtonTitle string Text of the button which finishes the flow
codeDensity CodeDensity The expected density of QR codes in an image.
replaceCancelButtonWithIcon boolean If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode CameraPreviewMode Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
autoCancelTimeout number Sets auto close timer in seconds. 0 = disabled and it is the default value. Android only
initialScanDelay number Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
viewFinderEnabled boolean Display the region of interest. The default value is TRUE.
overlayConfiguration SelectionOverlayConfiguration The selection overay configuration.

HealthInsuranceCardScannerResult

Prop Type Description
fields HealthInsuranceCardField[] The array of recognized Health Insurance Card fields

HealthInsuranceCardField

The Health Insurance Card field

Prop Type Description
type string Health Insurance Card Field Type
value string Health Insurance Card Field Recognized Text
confidence number Confidence in result accuracy. The value ranges from 0 to 100, higher is better.

HealthInsuranceCardScannerConfiguration

Prop Type Description
cameraModule CameraModule The preferred camera module (default - BACK)
cameraOverlayColor string Background color outside of the finder window.
cancelButtonTitle string Title of the cancel button.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
detectionStatusFailedDetectionText string String being displayed when health insurance card was not found.
detectionStatusFailedValidationText string String being displayed when health insurance card was found but not recognized.
detectionStatusSuccessText string String being displayed when health insurance card was found and recognized.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
finderTextHint string String being displayed as description.
finderTextHintColor string Foreground color of the description label.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle string Title of the flash toggle button. iOS only.
flashEnabled boolean Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor string The color of all inactive toggle buttons in the toolbar.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon boolean If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode CameraPreviewMode Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

TextDataScannerResult

Prop Type Description
result TextDataRecognitionResult The Text Data Scanner recognition result

TextDataRecognitionResult

The Text Data Recognition Result

Prop Type Description
text string The recognized text
confidence number Confidence in the accuracy of the recognition (from 0 to 100)

TextDataScannerConfiguration

Prop Type Description
cameraModule CameraModule The preferred camera module (default - BACK)
cameraOverlayColor string Background color outside of the finder window.
cancelButtonTitle string Title of the cancel button.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText string Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor string Foreground color of the detection overlay.
finderLineWidth number Width of finder frame border. Default is 2.
finderTextHintColor string Foreground color of the description label.
flashButtonHidden boolean Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle string Title of the flash toggle button. iOS only.
flashEnabled boolean Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode OrientationLockMode UI Interface orientation lock mode
topBarBackgroundColor string The background color of the top toolbar.
topBarButtonsActiveColor string The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor string The color of all inactive toggle buttons in the toolbar.
wordBoxHighlightColor string The color of the highlight of the wordboxes founded on the frame
wordBoxHighlightEnabled boolean If the wordboxes should be highlighted when were found on the frame
minimumNumberOfRequiredFramesWithEqualRecognitionResult number Minimum number of accumulated frames that have equal result
maximumNumberOfAccumulatedFrames number Maximum number of accumulated frames to inspect before actual result is returned
ocrResolutionLimit number The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower. 0 - do not rescale.
useButtonsAllCaps boolean Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon boolean If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode CameraPreviewMode Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled boolean Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
textDataScannerStep TextDataScannerStep Configuration for the scanned item

TextDataScannerStep

Configuration for the scanned item

Prop Type Description
guidanceText string User guidance hint text.
pattern string Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.
shouldMatchSubstring boolean If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to FALSE, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to FALSE.
preferredZoom number The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height
aspectRatio AspectRatio The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height
unzoomedFinderHeight number The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.
allowedSymbols string A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.
significantShakeDelay number Threshold used to pause the detection after significant movement occurred. Default = 0

LicensePlateScannerResult

Prop Type Description
licensePlate string The License Plate detected by the scanner
confidence number Confidence in result accuracy. The value ranges from 0 to 100, higher is better.
countryCode string The Country Code on the License Plate as detected by the scanner

LicensePlateScannerConfiguration

Prop Type Description
cameraModule CameraModule The preferred camera module (default - BACK)
cameraOverlayColor string Background color outside of the finder window.
cancelButtonTitle string Title of the cancel button.
cancelButtonHidden boolean Whether the cancel button is hidden or not. iOS only.
confirmationDialogStyle DialogStyle The style of the confirmation dialog. iOS Only.
confirmationDialogConfirmButtonStyle DialogButtonStyle The style of the confirmation dialogs confirm button. iOS Only.
confirmationDialogRetryButtonStyle DialogButtonStyle The style of the confirmation dialogs retry button. iOS Only.
enableCameraButtonTitle string Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText

Readme

Keywords

Package Sidebar

Install

npm i capacitor-plugin-scanbot-sdk

Homepage

scanbot.io/developer/capacitor-document-scanner-sdk/

Weekly Downloads

301

Version

4.2.0

License

Commercial

Unpacked Size

1.06 MB

Total Files

47

Last publish

Collaborators

  • scanbot
Try on RunKit
Report malware