### Install Cordova Barcode Scanner Plugin

Source: https://docs.scanbot.io/cordova/barcode-scanner-sdk/getting-started

Installs the Scanbot Barcode Scanner SDK Cordova Plugin using npm. This command adds the plugin to your Cordova or Ionic project.

```bash
$ cordova plugin add cordova-plugin-scanbot-barcode-scanner  

```

```bash
$ionic cordova plugin add cordova-plugin-scanbot-barcode-scanner  

```

--------------------------------

### Configure Introduction Screen (.NET Android)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/document-data-extractor/ready-to-use-ui

Provides an example of configuring the Introduction Screen for the Document Data Extractor on Android using .NET. It shows how to set up the screen's appearance, including background color, title, and image options, and initiates the scanning process.

```csharp
using Android.Content;
using AndroidX.AppCompat.App;
using IO.Scanbot.Sdk.Ui_v2.Common;
using IO.Scanbot.Sdk.Ui_v2.Documentdata;
using IO.Scanbot.Sdk.Ui_v2.Documentdataextractor.Configuration;
using IO.Scanbot.Sdk.UI.View.Base;

namespace ScanbotSdkExample.Droid.Snippets.DocumentDataExtractor;

public class IntroductionSnippet : AppCompatActivity
{
    private IO.Scanbot.Sdk.ScanbotSDK _scanbotSdk;
    private const int ScanDocumentDataExtractorRequestCode = 001;

    protected override void OnCreate(Bundle savedInstanceState)
    {
        base.OnCreate(savedInstanceState);

        // Returns the singleton instance of the Sdk.
        _scanbotSdk = new IO.Scanbot.Sdk.ScanbotSDK(this);

        if (_scanbotSdk.LicenseInfo.IsValid)
        {
            LaunchDocumentDataExtractor();
        }
    }

    private void LaunchDocumentDataExtractor()
    {
        // Create the default configuration object.
        var configuration = new DocumentDataExtractorScreenConfiguration();

        // Retrieve the instance of the intro screen from the configuration object.
        var introScreen = configuration.IntroScreen;
        introScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        introScreen.BackgroundColor = new ScanbotColor("#FFFFFF");

        // Configure the title for the intro screen.
        introScreen.Title.Text = "How to scan a DE Id Card";

        // Configure the image for the introduction screen.
        // If you want to have no image...
        introScreen.Image = new DocumentDataIntroNoImage();
        // For a custom image...

```

--------------------------------

### Install Cordova Scanbot SDK Plugin

Source: https://docs.scanbot.io/cordova/document-scanner-sdk/getting-started

Installs the Scanbot SDK Cordova Plugin using NPM. This command adds the plugin to your Cordova project, enabling document scanning functionalities.

```bash
cordova plugin add cordova-plugin-scanbot-sdk
```

```bash
ionic cordova plugin add cordova-plugin-scanbot-sdk
```

--------------------------------

### Configure Introduction Screen (.NET MAUI)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/document-data-extractor/ready-to-use-ui

Demonstrates how to configure the Introduction Screen for the Document Data Extractor in .NET MAUI. This includes setting automatic display, background color, title, custom images, handler and divider colors, explanation text, and the done button. It also shows how to launch the extractor and process the results.

```csharp
using ScanbotSDK.MAUI;
using ScanbotSDK.MAUI.DocumentDataExtractor;

namespace ScanbotSdkExample.Maui.Snippets.DocumentDataExtractor;

public class IntroductionSnippet
{
    public static async Task LaunchAsync()
    {
        // Create the default configuration object.
        var configuration = new DocumentDataExtractorScreenConfiguration();

        // Show the introduction screen automatically when the screen appears.
        configuration.IntroScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        configuration.IntroScreen.BackgroundColor = new ColorValue("#FFFFFF");

        // Configure the title for the intro screen.
        configuration.IntroScreen.Title.Text = "How to scan a document";

        // Configure the image for the introduction screen.
        configuration.IntroScreen.Image = new DocumentDataIntroNoImage();

        // For a custom image...
        configuration.IntroScreen.Image = new DocumentDataIntroCustomImage
        {
            Uri = "PathToImage"
        };

        // Or you can also use our default image.
        configuration.IntroScreen.Image = new DocumentDataIntroDefaultImage();

        // Configure the color of the handler on top.
        configuration.IntroScreen.HandlerColor = new ColorValue("#EFEFEF");

        // Configure the color of the divider.
        configuration.IntroScreen.DividerColor = new ColorValue("#EFEFEF");

        // Configure the text.
        configuration.IntroScreen.Explanation.Color = new ColorValue("#000000");
        configuration.IntroScreen.Explanation.Text = "To quickly and securely scan your document details, please hold your device over the document, so that the camera aligns with all the information on the document.\n\nThe scanner will guide you to the optimal scanning position. Once the scan is complete, your document details will automatically be extracted and processed.\n\nPress 'Start Scanning' to begin.";

        // Configure the done button.
        configuration.IntroScreen.DoneButton.Text = "Start Scanning";
        configuration.IntroScreen.DoneButton.Background.FillColor = new ColorValue("#C8193C");

        // Present the view controller modally.
        var scannedOutput = await ScanbotSDKMain.Rtu.DocumentDataExtractor.LaunchAsync(configuration);
        if (scannedOutput.Status != OperationResult.Ok)
        {
            // Indicates that cancel was tapped or the result was unsuccessful
            return;
        }

        // Iterate through all the document fields
        foreach (var field in scannedOutput.Result.Document.Fields)
        {
            Console.WriteLine($"{field.Type.Name}: {field.Value.Text}");
        }
    }
}

```

--------------------------------

### Configure Text Pattern Scanner Introduction (.NET Android)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/text-pattern-scanner/ready-to-use-ui

This snippet demonstrates how to set up the introduction screen for the Text Pattern Scanner on Android using .NET. It covers basic configuration of the intro screen, including setting the background color, title text, and image options. Note that this example shows only a portion of the configuration available.

```csharp
using Android.Content;
using AndroidX.AppCompat.App;
using IO.Scanbot.Sdk.Ui_v2.Common;
using IO.Scanbot.Sdk.Ui_v2.Textpattern;
using IO.Scanbot.Sdk.Ui_v2.Textpattern.Configuration;
using IO.Scanbot.Sdk.UI.View.Base;

namespace ScanbotSdkExample.Droid.Snippets.TextPatternScanner;

public class IntroductionSnippet : AppCompatActivity
{
    private IO.Scanbot.Sdk.ScanbotSDK _scanbotSdk;
    private const int ScanTextPatternRequestCode = 001;

    protected override void OnCreate(Bundle savedInstanceState)
    {
        base.OnCreate(savedInstanceState);
		  
        // Returns the singleton instance of the Sdk.
        _scanbotSdk = new IO.Scanbot.Sdk.ScanbotSDK(this);
		  
        if (_scanbotSdk.LicenseInfo.IsValid)
        {
            LaunchTextPatternScanner();
        }
    }
    private void LaunchTextPatternScanner()
    {
        var configuration = new TextPatternScannerScreenConfiguration();
          
        // Configure the intro screen
        var intro = configuration.IntroScreen;
        intro.ShowAutomatically = true;
        intro.BackgroundColor = new ScanbotColor("#FFFFFF");
          
        // Title
        intro.Title.Text = "How to scan text";
          
        // Image options
        intro.Image = new TextPatternIntroNoImage();
        // intro.Image = new TextPatternIntroCustomImage("PathToImage");
        // intro.Image = new TextPatternIntroMeterDevice(); // Only one should be set

```

--------------------------------

### Install Scanbot SDK via npm, Yarn, or Expo

Source: https://docs.scanbot.io/react-native/document-scanner-sdk/quick-start

Install the Scanbot SDK module using your preferred package manager. This makes the SDK available for use in your React Native project.

```bash
npm install react-native-scanbot-sdk
```

```bash
yarn add react-native-scanbot-sdk
```

```bash
npx expo install react-native-scanbot-sdk
```

--------------------------------

### Configure Introduction Screen with Kotlin

Source: https://docs.scanbot.io/android/document-scanner-sdk/ready-to-use-ui/scanning-flow/introduction-screen

Demonstrates how to set up and display a custom introduction screen for the document scanner. This involves creating a DocumentScanningFlow configuration, defining list items with images and styled text, and launching the scanner activity. It highlights setting an automatic display flag, custom images, text colors, and a screen title.

```kotlin
import io.scanbot.sdk.ui_v2.common.ScanbotColor  
import io.scanbot.sdk.ui_v2.common.StyledText  
import io.scanbot.sdk.ui_v2.document.DocumentScannerActivity  
import io.scanbot.sdk.ui_v2.document.configuration.DocumentScanningFlow  
import io.scanbot.sdk.ui_v2.document.configuration.IntroImage  
import io.scanbot.sdk.ui_v2.document.configuration.IntroListEntry  
  

class IntroductionSnippet : AppCompatActivity() {  
    override fun onCreate(savedInstanceState: Bundle?) {  
        super.onCreate(savedInstanceState)  
        // In the real application, you should call this function on button click  
        startScanning()  
    }  
  
    private val context = this  
    private val documentScannerResult: ActivityResultLauncher<DocumentScanningFlow> by lazy {  
        registerForActivityResult(DocumentScannerActivity.ResultContract()) { result ->  
            if (result.resultCode == Activity.RESULT_OK) {  
                result.result?.let { document ->  
                    // Handle the document.  
                }  
            } else {  
                // Indicates that the cancel button was tapped.  
            }  
        }  
    }  
  
    fun startScanning() {  
        // Create the default configuration object.  
        val configuration = DocumentScanningFlow().apply {  
  
            // Retrieve the instance of the introduction configuration from the main configuration object.  
            screens.camera.introduction.apply {  
  
                // Show the introduction screen automatically when the screen appears.  
                showAutomatically = true  
  
                // Create a new introduction item.  
                val firstExampleEntry = IntroListEntry()  
  
                // Configure the introduction image to be shown.  
                firstExampleEntry.image = IntroImage.receiptsIntroImage()  
  
                // Configure the text.  
                firstExampleEntry.text = StyledText(  
                    text = "Some text explaining how to scan a receipt",  
                    color = ScanbotColor(value = "#000000")  
                )  
  
                // Create a second introduction item.  
                val secondExampleEntry = IntroListEntry()  
  
                // Configure the introduction image to be shown.  
                secondExampleEntry.image = IntroImage.checkIntroImage()  
  
                // Configure the text.  
                secondExampleEntry.text =  
                    StyledText(  
                        text = "Some text explaining how to scan a check",  
                        color = ScanbotColor(value = "#000000")  
                    )  
  
                // Set the items into the configuration.  
                items = listOf(firstExampleEntry, secondExampleEntry)  
  
                // Set a screen title.  
                title = StyledText(  
                    text = "Introduction",  
                    color = ScanbotColor(value = "#000000")  
                )  
  
            }  
        }  
  
        // Start the recognizer activity.  
        documentScannerResult.launch(configuration)  
    }  
}
```

--------------------------------

### Start Document Single Page Scanning

Source: https://docs.scanbot.io/react-native/document-scanner-sdk/quick-start

Initiate the document scanning flow using the `startDocumentScanner` function and the `DocumentScanningFlow` configuration. This example sets the page limit to one and includes basic error handling.

```javascript
import {
  DocumentScanningFlow,
  startDocumentScanner,
} from 'react-native-scanbot-sdk/ui_v2';

async function useSinglePageScanning() {
  try {
    /** Create the configuration object for single page scanning */
    const configuration = new DocumentScanningFlow();
    configuration.outputSettings.pagesScanLimit = 1;

    /** See further customization configs... */

    const documentResult = await startDocumentScanner(configuration);
      
    /** Handle the document if the status is 'OK' */
    if (documentResult.status === 'OK') {
    }
  } catch (e: any) {
    console.error(e.message);
  }
}
```

--------------------------------

### Configure and Start Text Pattern Scanner (Swift/Objective-C)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/text-pattern-scanner/ready-to-use-ui

This example demonstrates how to configure the UI and behavior of the Text Pattern Scanner in iOS. It covers camera settings, UI elements, view finder styles, success overlay, sound, and vibration, before presenting the scanner.

```swift
let configuration = SBSDKUI2TextPatternScannerScreenConfiguration()

// Configure camera properties.
configuration.cameraConfiguration.zoomSteps = [ 1.0, 2.0, 5.0 ]
configuration.cameraConfiguration.flashEnabled = false
configuration.cameraConfiguration.pinchToZoomEnabled = true

// Configure the UI elements like icons or buttons.
configuration.topBarOpenIntroScreenButton.visible = true
configuration.topBarOpenIntroScreenButton.color = SBSDKUI2Color("#FFFFFF")

// Cancel button.
configuration.topBar.cancelButton.visible = true
configuration.topBar.cancelButton.text = "Cancel"
configuration.topBar.cancelButton.foreground.color = SBSDKUI2Color("#FFFFFF")
configuration.topBar.cancelButton.background.fillColor = SBSDKUI2Color("#00000000")

// Configure the view finder.
configuration.viewFinder.aspectRatio = SBSDKAspectRatio(3.85, 1.0)

// Configure the style for the view finder.
configuration.viewFinder.style = SBSDKUI2FinderStyle.finderStrokedStyle
configuration.viewFinder.style = SBSDKUI2FinderStyle.finderCorneredStyle
configuration.viewFinder.style = SBSDKUI2FinderCorneredStyle(SBSDKUI2Color("#7A000000"), 3.0, 2.0)

// Configure the success overlay.
configuration.successOverlay.iconColor = SBSDKUI2Color("#FFFFFF")
configuration.successOverlay.message.text = "Scanned Successfully!"
configuration.successOverlay.message.color = SBSDKUI2Color("#FFFFFF")

// Configure the sound.
configuration.sound.successBeepEnabled = true
configuration.sound.soundType = SBSDKUI2SoundType.modernBeep

// Configure the vibration.
configuration.vibration.enabled = false

// Present the view controller modally.
SBSDKUI2TextPatternScannerViewController.presentOn(self, configuration: configuration) { result in
    if let result = result {
        // Handle the result.
    } else {
        // Indicates that the cancel button was tapped.
    }
}
```

--------------------------------

### Launch Barcode Scanner UI

Source: https://docs.scanbot.io/web/barcode-scanner-sdk/ready-to-use-ui/how-to-get-started

This JavaScript function demonstrates how to launch the RTU UI barcode scanner. It allows for optional configuration and returns the scan results. Ensure you have the 'scanbot-web-sdk' and '@types' packages installed.

```javascript
import ScanbotSDK from "scanbot-web-sdk/ui";
import { UIConfig } from "scanbot-web-sdk/@types";

export async function startScanner(config?: UIConfig.BarcodeScannerScreenConfiguration) {
    // Configure as needed
    if (!config) {
        config = new ScanbotSDK.UI.Config.BarcodeScannerScreenConfiguration();
    }
    const result = await ScanbotSDK.UI.createBarcodeScanner(config);
    // Process & present the result as needed
    return result;
}
```

--------------------------------

### Prepare and Launch Document Scanner Screen (Kotlin)

Source: https://docs.scanbot.io/android/document-scanner-sdk/quick-start

Initialize the ActivityResultLauncher in your Activity's onCreate method. Define a callback to handle the result, displaying the first page preview. A button click listener is set up to launch the document scanner using the initialized launcher and a configured DocumentScanningFlow object.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.quick_start_snippets_activity)

    // ...
    // After the super.onCreate(...) and ScanbotSDKInitializer call:

    // We will use this image view to display the first page preview image, it should exist in your layout xml:
    val previewImageView = findViewById<ImageView>(R.id.first_page_image_preview)

    documentScreenLauncher = 
        registerForActivityResultOk(DocumentScannerActivity.ResultContract()) { 
                resultEntity: DocumentScannerActivity.Result -> 
            val result: Document? = resultEntity.result
            val pages: List<Page>? = result?.pages

            // Display the first page preview image:
            pages?.get(0)?.let { 
                val previewImage = it.documentPreviewImage
                previewImageView.setImageBitmap(previewImage)
            }
        }

    // Set up a button to open the document scanner, it should exist in your layout xml:
    findViewById<Button>(R.id.open_document_scanner).setOnClickListener {
        openDocumentScannerRtuV2()
    }
}

// Launch the Document Scanner in your Activity:
private fun openDocumentScannerRtuV2() {
    val configuration = DocumentScanningFlow().apply {
        // Customize text resources, behavior and UI:
        // ...
    }

    documentScreenLauncher.launch(configuration)
}
```

--------------------------------

### Expo Configuration Plugin for Scanbot SDK

Source: https://docs.scanbot.io/react-native/document-scanner-sdk/quick-start

Configure the Scanbot SDK for Expo using the provided config plugin in your app config file. This example shows how to set iOS camera usage description and other options.

```json
"plugins": [
  [
    "react-native-scanbot-sdk",
    {
      "iOSCameraUsageDescription": "Document & Barcode Scanning permission",
      "largeHeap": true,
      "mavenURLs": true,
      "ocrBlobsDirPath": "./ocr_blobs"
    }
  ]
]
```

--------------------------------

### AdaptiveFinderOverlayView Setup with ContourDetectorFrameHandler (Kotlin)

Source: https://docs.scanbot.io/android/barcode-scanner-sdk/classic-ui/how-to-get-started

This Kotlin code sets up `AdaptiveFinderOverlayView` along with `ContourDetectorFrameHandler`. It configures both components with a list of acceptable page aspect ratios, allowing the finder view to adjust its borders to detected documents that match these ratios.

```kotlin
val cameraView = findViewById<ScanbotCameraXView>(R.id.camera_view)
val finderOverlayView = findViewById<AdaptiveFinderOverlayView>(R.id.my_finder_view)

// we can use several aspect ratios:  
val pageAspectRatios = listOf( // this will be used for ContourDetectorFrameHandler  
        PageAspectRatio(21.0, 29.7), // a4 sheet size  
        PageAspectRatio(85.60, 53.98)) // credit card size  
val finderAspectRatios = pageAspectRatios.toFinderAspectRatios() // for AdaptiveFinderOverlayView
myFinderOverlayView.setRequiredAspectRatios(finderAspectRatios)

val contourDetectorFrameHandler = ContourDetectorFrameHandler.attach(cameraView, scanbotSDK.createContourDetector())
contourDetectorFrameHandler.setRequiredAspectRatios(pageAspectRatios)
contourDetectorFrameHandler.addResultHandler(finderOverlayView.contourDetectorFrameHandler)

```

--------------------------------

### Configure Document Data Extractor Introduction Screen (Swift)

Source: https://docs.scanbot.io/ios/data-capture-modules/document-data-extractor/ready-to-use-ui

This Swift code snippet demonstrates how to configure the introduction screen for the Scanbot SDK's Document Data Extractor. It covers setting up properties such as background color, title text, image, handler color, divider color, explanation text, and the 'Start Scanning' button. The configuration is then used to present the introduction screen modally. It also includes a basic example of how to handle the extraction results, specifically casting the generic document to a German ID card front model and accessing its fields.

```swift
import ScanbotSDK

class DocumentDataExtractorIntroductionUI2ViewController: UIViewController {
      
    override func viewDidLoad () {
        super.viewDidLoad()
          
        // Start scanning here. Usually this is an action triggered by some button or menu.
        startScanning()
    }
      
    func startScanning() {
          
        // Create the default configuration object.
        let configuration = SBSDKUI2DocumentDataExtractorScreenConfiguration()
          
        // Show the introduction screen automatically when the screen appears.
        configuration.introScreen.showAutomatically = true
          
        // Configure the background color of the screen.
        configuration.introScreen.backgroundColor = SBSDKUI2Color(colorString: "#FFFFFF")
          
        // Configure the title for the intro screen.
        configuration.introScreen.title.text = "How to scan a document"
          
        // Configure the image for the introduction screen.
        // If you want to have no image...
        configuration.introScreen.image = .documentDataIntroNoImage()
        // For a custom image...
        configuration.introScreen.image = .documentDataIntroCustomImage(uri: "PathToImage")
        // Or you can also use our default image.
        configuration.introScreen.image = .documentDataIntroDefaultImage()
          
        // Configure the color of the handler on top.
        configuration.introScreen.handlerColor = SBSDKUI2Color(colorString: "#EFEFEF")
          
        // Configure the color of the divider.
        configuration.introScreen.dividerColor = SBSDKUI2Color(colorString: "#EFEFEF")
          
        // Configure the text.
        configuration.introScreen.explanation.color = SBSDKUI2Color(colorString: "#000000")
        configuration.introScreen.explanation.text = "To quickly and securely scan your document details, please hold your device over the document, so that the camera aligns with all the information on the document.\n\nThe scanner will guide you to the optimal scanning position. Once the scan is complete, your document details will automatically be extracted and processed.\n\nPress 'Start Scanning' to begin."
          
        // Configure the done button.
        // e.g the text or the background color.
        configuration.introScreen.doneButton.text = "Start Scanning"
        configuration.introScreen.doneButton.background.fillColor = SBSDKUI2Color(colorString: "#C8193C")
          
        // Present the view controller modally.
        SBSDKUI2DocumentDataExtractorViewController.present(on: self, 
                                                   configuration: configuration) { result in
            if let result {
                // Handle the result.
                  
                // Cast the resulted generic document to the appropriate document model using the `wrap` method.
                if let genericDocument = result.document, let wrapper = genericDocument.wrap() {
                    // Use SBSDKDocumentsModelDeIdCardFront for German ID card front side
                    if let idCardFront = wrapper as? SBSDKDocumentsModelDeIdCardFront {
                        // Retrieve values from the German ID card front
                        if let birthDate = idCardFront.birthDate?.value {
                            print("Birth date: \(birthDate.text), Confidence: \(birthDate.confidence)")
                        }
                        if let birthplace = idCardFront.birthplace?.value {
                            print("Birthplace: \(birthplace.text), Confidence: \(birthplace.confidence)")
                        }
                        if let cardAccessNumber = idCardFront.cardAccessNumber?.value {
                            print("Card access number: \(cardAccessNumber.text), Confidence: \(cardAccessNumber.confidence)")
                        }
                        if let expiryDate = idCardFront.expiryDate?.value {
                            print("Expiry date: \(expiryDate.text), Confidence: \(expiryDate.confidence)")
                        }
                        if let givenNames = idCardFront.givenNames?.value {
                            print("Given names: \(givenNames.text), Confidence: \(givenNames.confidence)")
                        }
                        if let id = idCardFront.id?.value {
                            print("ID: \(id.text), Confidence: \(id.confidence)")
                        }
                        if let maidenName = idCardFront.maidenName?.value {

```

--------------------------------

### Install Scanbot SDK using Expo

Source: https://docs.scanbot.io/react-native/document-scanner-sdk/detailed-setup-guide/installation

Installs the Scanbot SDK module into your Expo project using the `npx expo install` command. This command ensures compatibility with the Expo managed workflow.

```bash
npx expo install react-native-scanbot-sdk  
```

--------------------------------

### Configure Introduction Screen (.NET MAUI)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/document-scanner/ready-to-use-ui

This snippet demonstrates how to configure the introduction screen for the document scanner in .NET MAUI. It allows setting custom text and images for each introduction step, as well as a screen title. The introduction screen can be set to show automatically when the scanner launches.

```csharp
using ScanbotSDK.MAUI;
using ScanbotSDK.MAUI.Document;
using ScanbotSDK.MAUI.Common;

namespace ScanbotSdkExample.Maui.Snippets.DocumentScanner;

public static class IntroductionSnippet
{
    private static async Task LaunchAsync()
    {
        // Create the default configuration object.
        var configuration = new DocumentScanningFlow();

        // Retrieve the instance of the introduction configuration from the main configuration object.
        var introductionConfiguration = configuration.Screens.Camera.Introduction;

        // Show the introduction screen automatically when the screen appears.
        introductionConfiguration.ShowAutomatically = true;

        // Create a new introduction item.
        var firstExampleEntry = new IntroListEntry();

        // Configure the introduction image to be shown.
        firstExampleEntry.Image = new ReceiptsIntroImage();

        // Configure the text.
        firstExampleEntry.Text = new StyledText
        {
            Visible = true,
            Text = "Some text explaining how to scan a receipt",
            Color = new ColorValue("#000000"),
            UseShadow = false
        };

        // Create a second introduction item.
        var secondExampleEntry = new IntroListEntry();

        // Configure the introduction image to be shown.
        secondExampleEntry.Image = new CheckIntroImage();

        // Configure the text.
        secondExampleEntry.Text = new StyledText
        {
            Visible = true,
            Text = "Some text explaining how to scan a check",
            Color = new ColorValue("#000000"),
            UseShadow = false
        };

        // Set the items into the configuration.
        introductionConfiguration.Items = [firstExampleEntry, secondExampleEntry];

        // Set a screen title.
        introductionConfiguration.Title = new StyledText
        {
            Visible = true,
            Text = "Introduction",
            Color = new ColorValue("#000000"),
            UseShadow = true
        };

        // Apply the introduction configuration.
        configuration.Screens.Camera.Introduction = introductionConfiguration;

        // Launch the scanner
        var response = await ScanbotSDKMain.Rtu.DocumentScanner.LaunchAsync(configuration);
        if (response.Status != OperationResult.Ok)
        {
            // Indicates that the cancel button was tapped.
            return;
        }
          
        // Handle the document.
        var scannerDocument = response.Result;
    }
}

```

--------------------------------

### Integrate BarcodeScannerView in Android Layout

Source: https://docs.scanbot.io/android/barcode-scanner-sdk/classic-ui/how-to-get-started

Add the `BarcodeScannerView` to your XML layout file to display the camera preview and barcode scanning UI. This view encapsulates the entire barcode scanning feature, eliminating the need for separate camera or finder view setups.

```xml
<io.scanbot.sdk.barcode.ui.BarcodeScannerView 
    android:id="@+id/barcode_scanner_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

```

--------------------------------

### Configure Text Pattern Scanner Introduction (.NET MAUI)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/text-pattern-scanner/ready-to-use-ui

This snippet shows how to configure the introduction screen for the Text Pattern Scanner in .NET MAUI. It allows customization of the screen's appearance, including background color, title, image (with options for no image, custom, or default images), handler color, divider color, explanation text, and the 'Done' button. It also demonstrates launching the scanner and retrieving the scanned text.

```csharp
using ScanbotSDK.MAUI;
using ScanbotSDK.MAUI.TextPattern;

namespace ScanbotSdkExample.Maui.Snippets.TextPatternScanner;

public class IntroductionSnippet
{
    public static async Task LaunchAsync()
    {
        // Create the default configuration object.
        var configuration = new TextPatternScannerScreenConfiguration();

        // Show the introduction screen automatically when the screen appears.
        configuration.IntroScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        configuration.IntroScreen.BackgroundColor = new ColorValue("#FFFFFF");

        // Configure the title for the intro screen.
        configuration.IntroScreen.Title.Text = "How to scan text";

        // Configure the image for the introduction screen.
        // If you want to have no image...
        configuration.IntroScreen.Image = new TextPatternIntroNoImage();
        // For a custom image...
        configuration.IntroScreen.Image = new TextPatternIntroCustomImage { Uri = "PathToImage" };
        // Or you can also use one of our default images.
        // e.g the meter device image.
        configuration.IntroScreen.Image = new TextPatternIntroMeterDevice();
        // shipping container image.
        configuration.IntroScreen.Image = new TextPatternIntroShippingContainer();
        // general text field image.
        configuration.IntroScreen.Image = new TextPatternIntroGeneralField();
        // alphabetic text field image.
        configuration.IntroScreen.Image = new TextPatternIntroAlphabeticField();

        // Configure the color of the handler on top.
        configuration.IntroScreen.HandlerColor = new ColorValue("#EFEFEF");

        // Configure the color of the divider.
        configuration.IntroScreen.DividerColor = new ColorValue("#EFEFEF");

        // Configure the text.
        configuration.IntroScreen.Explanation.Color = new ColorValue("#000000");
        configuration.IntroScreen.Explanation.Text =
            "To scan a single line of text, please hold your device so that the camera viewfinder clearly captures the text you want to scan. Please ensure the text is properly aligned. Once the scan is complete, the text will be automatically extracted.\n\nPress 'Start Scanning' to begin.";

        // Configure the done button.
        // e.g the text or the background color.
        configuration.IntroScreen.DoneButton.Text = "Start Scanning";
        configuration.IntroScreen.DoneButton.Background.FillColor = new ColorValue("#C8193C");

        // Present the view controller modally.
        var scannedOutput = await ScanbotSDKMain.Rtu.TextPatternScanner.LaunchAsync(configuration);
        if (scannedOutput.Status != OperationResult.Ok)
        {
            // Indicates that cancel was tapped or the result was unsuccessful
            return;
        }

        // Retrieve the value.
        // e.g
        Console.WriteLine($"Scanned Text: " + scannedOutput.Result.RawText);
    }
}
```

--------------------------------

### Configure Introduction Screen for Document Scanning - Swift

Source: https://docs.scanbot.io/ios/document-scanner-sdk/ready-to-use-ui/scanning-flow/introduction-screen

This Swift code configures the Introduction Screen for document scanning using the Scanbot SDK. It demonstrates how to set custom images, text, and titles for introductory steps, and present the scanner with this configuration. Dependencies include the ScanbotSDK framework.

```swift
import ScanbotSDK

class DocumentIntroductionUI2ViewController: UIViewController {
      
    override func viewDidLoad() {
        super.viewDidLoad("example", color: "#000000"))
    }
      
    func startScanning() {
          
        // Create the default configuration object.
        let configuration = SBSDKUI2DocumentScanningFlow()
          
        // Retrieve the instance of the introduction configuration from the main configuration object.
        let introductionConfiguration = configuration.screens.camera.introduction
          
        // Show the introduction screen automatically when the screen appears.
        introductionConfiguration.showAutomatically = true
          
        // Create a new introduction item.
        let firstExampleEntry = SBSDKUI2IntroListEntry()
          
        // Configure the introduction image to be shown.
        firstExampleEntry.image = .receiptsIntroImage()
          
        // Configure the text.
        firstExampleEntry.text = SBSDKUI2StyledText(text: "Some text explaining how to scan a receipt",
                                                    color: SBSDKUI2Color(colorString: "#000000"))
          
        // Create a second introduction item.
        let secondExampleEntry = SBSDKUI2IntroListEntry()
          
        // Configure the introduction image to be shown.
        secondExampleEntry.image = .checkIntroImage()
          
        // Configure the text.
        secondExampleEntry.text = SBSDKUI2StyledText(text: "Some text explaining how to scan a check",
                                                     color: SBSDKUI2Color(colorString: "#000000"))
          
        // Set the items into the configuration.
        introductionConfiguration.items = [firstExampleEntry, secondExampleEntry]
          
        // Set the screen title.
        introductionConfiguration.title = SBSDKUI2StyledText(text: "Introduction",
                                                           color: SBSDKUI2Color(colorString: "#000000"))
          
        // Apply the introduction configuration.
        configuration.screens.camera.introduction = introductionConfiguration
          
        // Present the view controller modally.
        SBSDKUI2DocumentScannerController.present(on: self,
                                                  configuration: configuration) { document in
              
            // Completion handler to process the result.
              
            if let document {
                // Handle the document.
                  
            } else {
                // Indicates that the cancel button was tapped.
            }
        }
    }
}

```

--------------------------------

### Install CocoaPods Dependencies

Source: https://docs.scanbot.io/compose/barcode-scanner-sdk/detailed-setup-guide/installation

Command to install the CocoaPods dependencies for the iOS project after modifying the `Podfile`. The `--repo-update` flag ensures the local CocoaPods repository is up-to-date.

```bash
pod install --repo-update

```

--------------------------------

### Integrate Button to Start Scanner (Flutter)

Source: https://docs.scanbot.io/flutter/document-scanner-sdk/quick-start

An example of an ElevatedButton widget that triggers the `_startDocumentScanning` function when pressed, initiating the document scanning process.

```dart
ElevatedButton(
    onPressed: _startDocumentScanning,
    child: const Text("Start single-barcode scanning"),
),

```

--------------------------------

### Configure Introduction Screen (Android)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/document-scanner/ready-to-use-ui

This snippet shows how to set up the introduction screen for the document scanner on Android using the Scanbot SDK. It involves creating custom introduction items with images and styled text, and setting a title for the screen. The configuration is applied when launching the document scanner.

```csharp
using Android.Content;
using AndroidX.AppCompat.App;
using IO.Scanbot.Sdk.Ui_v2.Common;
using IO.Scanbot.Sdk.Ui_v2.Document;
using IO.Scanbot.Sdk.Ui_v2.Document.Configuration;

namespace ScanbotSdkExample.Droid.Snippets;

public class IntroductionSnippet : AppCompatActivity
{
	private IO.Scanbot.Sdk.ScanbotSDK _scanbotSdk;
	private const int ScanDocumentRequestCode = 001;

	protected override void OnCreate(Bundle savedInstanceState)
	{
		base.OnCreate(savedInstanceState);

		// Returns the singleton instance of the Sdk.
		_scanbotSdk = new IO.Scanbot.Sdk.ScanbotSDK(this);

		if (_scanbotSdk.LicenseInfo.IsValid)
		{
			LaunchDocumentScanner();
		}
	}

	private void LaunchDocumentScanner()
	{
		// Create the default configuration object.
		var configuration = new DocumentScanningFlow();

		configuration.Screens.Camera.Introduction.ShowAutomatically = true;
		  
		// Create a new introduction item.
		var firstExampleEntry = new IntroListEntry();

		// Configure the introduction image to be shown.
		firstExampleEntry.Image = IntroImage.ReceiptsIntroImage();

		// Configure the text.
		firstExampleEntry.Text = new StyledText(true, "Some text explaining how to scan a receipt", new ScanbotColor("#000000"), false);
		  
		// Create a second introduction item.
		var secondExampleEntry = new IntroListEntry();

		// Configure the introduction image to be shown.
		secondExampleEntry.Image = IntroImage.CheckIntroImage();

		// Configure the text.
		secondExampleEntry.Text =  new StyledText(true, "Some text explaining how to scan a check", new ScanbotColor("#000000"), false);

		// Set the items into the configuration.
		configuration.Screens.Camera.Introduction.Items = new [] {firstExampleEntry, secondExampleEntry };
		  
		// Set a screen title.

```

--------------------------------

### Configure and Launch MRZ Scanner Introduction (.NET MAUI)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/mrz-scanner/ready-to-use-ui

This snippet shows how to configure the MRZ scanner's introduction screen in .NET MAUI. It allows customization of the title, image, explanation text, and button. It also demonstrates how to launch the scanner and process the MRZ results.

```csharp
using ScanbotSDK.MAUI;
using ScanbotSDK.MAUI.DocumentsModel;
using ScanbotSDK.MAUI.Mrz;

namespace ScanbotSdkExample.Maui.Snippets.MrzScanner;

public class IntroductionSnippet
{
    public static async Task LaunchAsync()
    {
        // Create the default configuration object.
        var configuration = new MrzScannerScreenConfiguration();

        // Show the introduction screen automatically when the screen appears.
        configuration.IntroScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        configuration.IntroScreen.BackgroundColor = new ColorValue("#FFFFFF");

        // Configure the title for the intro screen.
        configuration.IntroScreen.Title.Text = "How to scan an MRZ";

        // Configure the image for the introduction screen.
        // If you want to have no image...
        configuration.IntroScreen.Image = new MrzIntroNoImage();

        // For a custom image...
        configuration.IntroScreen.Image = new MrzIntroCustomImage { Uri = "PathToImage" };

        // Or you can also use our default image.
        configuration.IntroScreen.Image = new MrzIntroDefaultImage();

        // Configure the color of the handler on top.
        configuration.IntroScreen.HandlerColor = new ColorValue("#EFEFEF");

        // Configure the color of the divider.
        configuration.IntroScreen.DividerColor = new ColorValue("#EFEFEF");

        // Configure the text.
        configuration.IntroScreen.Explanation.Color = new ColorValue("#000000");
        configuration.IntroScreen.Explanation.Text =
            "The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.\n\nTo scan it, simply hold your camera over the document, so that it aligns with the MRZ section. Once scanned, the data will be automatically processed, and you will be directed to the results screen.\n\nPress 'Start Scanning' to begin.";

        // Configure the done button.
        configuration.IntroScreen.DoneButton.Text = "Start Scanning";
        configuration.IntroScreen.DoneButton.Background.FillColor = new ColorValue("#C8193C");

        // Present the view controller modally.
        var scannedOutput = await ScanbotSDKMain.Rtu.MrzScanner.LaunchAsync(configuration);
        if (scannedOutput.Status != OperationResult.Ok)
        {
            // Indicates that cancel was tapped or the result was unsuccessful
            return;
        }

        // Wrap the resulted generic document to the strongly typed mrz class.
        var mrz = new MRZ(scannedOutput.Result.MrzDocument);

        // Retrieve the values.
        // e.g
        Console.WriteLine($"Birth Date: {mrz.BirthDate.Value.Text}, Nationality: {mrz.Nationality.Value.Text}");
    }
}

```

--------------------------------

### Custom Finder View with android.view.View and ScanbotCameraXView

Source: https://docs.scanbot.io/android/barcode-scanner-sdk/classic-ui/how-to-get-started

This example shows how to use a generic `android.view.View` as a custom finder view for complete control over its appearance. It's integrated with `ScanbotCameraXView` using `app:finder_view_id`. The custom view is positioned at the bottom with specific margins and a background drawable, demonstrating flexibility in UI design.

```xml
<io.scanbot.sdk.ui.camera.ScanbotCameraXView 
    android:id="@id/camera_view" 
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:finder_view_id="@id/my_finder_view" /> 

<View 
    android:id="@id/my_finder_view"
    android:layout_width="match_parent"
    android:layout_height="100dp"
    android:layout_gravity="bottom"
    android:layout_marginLeft="20dp"
    android:layout_marginRight="20dp"
    android:layout_marginBottom="200dp"
    android:background="@drawable/finder_view_container_bg" />


```

--------------------------------

### Configure and Launch MRZ Scanner Introduction (Android)

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/mrz-scanner/ready-to-use-ui

This snippet demonstrates how to configure and launch the MRZ scanner introduction screen on Android using the Scanbot SDK. It shows how to set up the introduction screen's appearance, including background color, title, image, and explanation text.

```csharp
using Android.Content;
using AndroidX.AppCompat.App;
using IO.Scanbot.Sdk.Documentdata.Entity;
using IO.Scanbot.Sdk.Ui_v2.Common;
using IO.Scanbot.Sdk.Ui_v2.Mrz;
using IO.Scanbot.Sdk.Ui_v2.Mrz.Configuration;
using IO.Scanbot.Sdk.UI.View.Base;

namespace ScanbotSdkExample.Droid.Snippets.MrzScanner;

public class IntroductionSnippet : AppCompatActivity
{
    private IO.Scanbot.Sdk.ScanbotSDK _scanbotSdk;
    private const int ScanMrzRequestCode = 001;

    protected override void OnCreate(Bundle savedInstanceState)
    {
        base.OnCreate(savedInstanceState);
		  
        // Returns the singleton instance of the Sdk.
        _scanbotSdk = new IO.Scanbot.Sdk.ScanbotSDK(this);
		  
        if (_scanbotSdk.LicenseInfo.IsValid)
        {
            LaunchMrzScanner();
        }
    }
    private void LaunchMrzScanner()
    {
        var configuration = new MrzScannerScreenConfiguration();

        // Retrieve the instance of the intro screen from the configuration object.
        var introScreen = configuration.IntroScreen;
          
        // Show the introduction screen automatically when the screen appears.
        introScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        introScreen.BackgroundColor = new ScanbotColor("#FFFFFF");

        // Configure the title for the intro screen.
        introScreen.Title.Text = "How to scan an MRZ";

        // Configure the image for the introduction screen.
        // If you want to have no image...
        introScreen.Image = new MrzIntroNoImage();
          

```

--------------------------------

### Get OCR Configs API

Source: https://docs.scanbot.io/cordova/document-scanner-sdk/features/ocr

Retrieve OCR configuration properties for the current app installation.

```APIDOC
## Get OCR Configs API

### Description
Use the `ScanbotSdk.getOcrConfigs()` function to retrieve OCR-related properties of the current app installation.

### Method
`ScanbotSdk.getOcrConfigs()`

### Response Fields
- **`languageDataPath`** (string) - The absolute file URI of the directory where OCR training data files should be placed at run-time.
- **`installedLanguages`** (array of strings) - An array of currently installed OCR languages (e.g., `["en", "fr"]`). The SDK determines installed languages from the `languageDataPath` directory.
```

--------------------------------

### Install Scanbot Barcode Scanner SDK package

Source: https://docs.scanbot.io/flutter/barcode-scanner-sdk/quick-start

This command adds the Scanbot Barcode Scanner SDK package to your Flutter project. Ensure you have Flutter installed and configured in your environment.

```bash
flutter pub add barcode_scanner  

```

--------------------------------

### Configure .NET MAUI Credit Card Scanner Introduction

Source: https://docs.scanbot.io/maui/document-scanner-sdk/sdk-features/credit-card-scanner/ready-to-use-ui

This snippet demonstrates how to configure the introduction screen for the credit card scanner in a .NET MAUI application. It allows customization of the screen's appearance, including background color, title, image (with options for default or custom images), and the 'Done' button text and color. It also shows how to set the explanatory text and handle the scanner's output.

```csharp
using ScanbotSDK.MAUI;
using ScanbotSDK.MAUI.CreditCard;
using ScanbotSDK.MAUI.CreditCardDocumentModel;

namespace ScanbotSdkExample.Maui.Snippets.CreditCardScanner;

public class IntroductionSnippet
{
    public static async Task LaunchAsync()
    {
        // Create the default configuration object.
        var configuration = new CreditCardScannerScreenConfiguration();

        // Show the introduction screen automatically when the screen appears.
        configuration.IntroScreen.ShowAutomatically = true;

        // Configure the background color of the screen.
        configuration.IntroScreen.BackgroundColor = new ColorValue("#FFFFFF");

        // Configure the title for the intro screen.
        configuration.IntroScreen.Title.Text = "How to scan a credit card";

        // Configure the image for the introduction screen.
        configuration.IntroScreen.Image = new CreditCardNoImage();

        // For a custom image...
        configuration.IntroScreen.Image = new CreditCardIntroCustomImage
        {
            Uri = "PathToImage"
        };

        // Or you can also use our default one side image.
        configuration.IntroScreen.Image = new CreditCardIntroOneSideImage();

        // Or you can also use our default two sides image.
        configuration.IntroScreen.Image = new CreditCardIntroTwoSidesImage();

        // Configure the color of the handler on top.
        configuration.IntroScreen.HandlerColor = new ColorValue("#EFEFEF");

        // Configure the color of the divider.
        configuration.IntroScreen.DividerColor = new ColorValue("#EFEFEF");

        // Configure the text.
        configuration.IntroScreen.Explanation.Color = new ColorValue("#000000");
        configuration.IntroScreen.Explanation.Text =
            "To quickly and securely input your credit card details, please hold your device over the credit card, so that the camera aligns with the numbers on the front of the card.\n\n" +
            "The scanner will guide you to the optimal scanning position. Once the scan is complete, your card details will automatically be extracted and processed.\n\n" +
            "Press 'Start Scanning' to begin.";

        // Configure the done button.
        configuration.IntroScreen.DoneButton.Text = "Start Scanning";
        configuration.IntroScreen.DoneButton.Background.FillColor = new ColorValue("#C8193C");

        // Present the view controller modally.
        var scannedOutput = await ScanbotSDKMain.Rtu.CreditCardScanner.LaunchAsync(configuration);
        if (scannedOutput.Status != OperationResult.Ok)
        {
            // Indicates that cancel was tapped or the result was unsuccessful
            return;
        }

        // Wrap the resulted generic document to the strongly typed credit card.
        var creditCard = new CreditCard(scannedOutput.Result.CreditCard);

        // Retrieve the values.
        // e.g
        Console.WriteLine($"Card number: {creditCard.CardNumber.Value.Text}, Cardholder Name: {creditCard.CardholderName?.Value?.Text}");
    }
}
```

--------------------------------

### Install Scanbot SDK module

Source: https://docs.scanbot.io/capacitor/document-scanner-sdk/quick-start

Installs the Scanbot Document Scanner SDK module for Capacitor. This command should be run in the root project folder. No external dependencies are required beyond npm.

```bash
npm i capacitor-plugin-scanbot-sdk  

```

--------------------------------

### Configure Introduction Screen with Capacitor Scanbot SDK

Source: https://docs.scanbot.io/capacitor/document-scanner-sdk/features/document-scanner/ready-to-use-ui

This snippet demonstrates how to configure and display a custom introduction screen for the document scanner using the Scanbot SDK for Capacitor. It allows setting a title, adding multiple introduction items, each with a custom image and text. The introduction screen is automatically shown when the scanner starts.

```typescript
import {
  CheckIntroImage,
  DocumentScanningFlow,
  IntroListEntry,
  ReceiptsIntroImage,
  startDocumentScanner,
  StyledText,
} from 'capacitor-plugin-scanbot-sdk/ui_v2';

async function startScanning() {
  try {
    /** Create the default configuration instance */
    const configuration = new DocumentScanningFlow();
    /** Retrieve the instance of the introduction configuration from the main configuration object. */
    const introductionConfiguration = configuration.screens.camera.introduction;
    /** Show the introduction screen automatically when the screen appears. */
    introductionConfiguration.showAutomatically = true;
    /** Create a new introduction item. */
    const firstExampleEntry = new IntroListEntry();
    /** Configure the introduction image to be shown. */
    firstExampleEntry.image = new ReceiptsIntroImage();
    /** Configure the text. */
    firstExampleEntry.text = new StyledText({
      text: 'Some text explaining how to scan a receipt',
      color: '#000000',
    });
    /** Create a second introduction item. */
    const secondExampleEntry = new IntroListEntry();
    /** Configure the introduction image to be shown. */
    secondExampleEntry.image = new CheckIntroImage();
    /** Configure the text. */
    secondExampleEntry.text = new StyledText({
      text: 'Some text explaining how to scan a check',
      color: '#000000',
    });
    /** Set the items into the configuration. */
    introductionConfiguration.items = [firstExampleEntry, secondExampleEntry];
    /** Set a screen title. */
    introductionConfiguration.title = new StyledText({
      text: 'Introduction',
      color: '#000000',
    });
    /** Start the Document Scanner UI */
    const documentResult = await startDocumentScanner(configuration);
    /** Handle the document if the status is 'OK' */
    if (documentResult.status === 'OK') {
    }
  } catch (e: any) {
    console.error(e.message);
  }
}
```