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(...)
• closeDocumentScanner()
• startFinderDocumentScanner(...)
• closeFinderDocumentScanner()
• startCroppingScreen(...)
• closeCroppingScreen()
• startMrzScanner(...)
• closeMrzScanner()
• startBarcodeScanner(...)
• closeBarcodeScanner()
• startBatchBarcodeScanner(...)
• closeBatchBarcodeScanner()
• startEHICScanner(...)
• closeEHICScanner()
• startTextDataScanner(...)
• closeTextDataScanner()
• startLicensePlateScanner(...)
• closeLicensePlateScanner()
• startMedicalCertificateRecognizer(...)
• closeMedicalCertificateRecognizer()
• startGenericDocumentRecognizer(...)
• closeGenericDocumentRecognizer()
• startCheckRecognizer(...)
• closeCheckRecognizer()
• startVinScanner(...)
• closeVinScanner()
• initializeSDK(...)
• getLicenseInfo()
• detectBarcodesOnImage(...)
• detectBarcodesOnImages(...)
• applyImageFilter(...)
• applyImageFilterOnPage(...)
• getImageData(...)
• rotateImage(...)
• createPage(...)
• removePage(...)
• rotatePage(...)
• setDocumentImage(...)
• detectDocument(...)
• detectDocumentOnPage(...)
• documentQualityAnalyzer(...)
• extractImagesFromPdf(...)
• extractPagesFromPdf(...)
• recognizeCheck(...)
• recognizeMrz(...)
• refreshImageUris(...)
• getOCRConfigs()
• cleanup()
• getFilteredDocumentPreviewUri(...)
• performOCR(...)
• createPDF(...)
• writeTIFF(...)
• Interfaces
• Type Aliases

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.