Scanbot SDK

https://docs.scanbot.io
Admin
Scanbot SDK provides developer tools and API references for integrating barcode scanning, document...
Tokens:351,582
Snippets:5,389
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install the Document Scanner SDK

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

Run this command in your root project folder to install the plugin.

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

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

### Configure Activity and Permissions

Source: https://docs.scanbot.io/xamarin/barcode-scanner-sdk/barcode-scanner

Activity setup including camera permission checks.

```csharp
[Activity(Theme = "@style/AppTheme")]  
public class ExampleBarcodeActivity : AppCompatActivity  
{  
    ScanbotCameraXView cameraView;  
    ImageView resultView;  
  
    const int REQUEST_PERMISSION_CODE = 200;  
    public string[] Permissions  
    {  
        get => new string[] { Manifest.Permission.Camera };  
    }  
      
    protected override void OnResume()  
    {  
        base.OnResume();  
        var status = ContextCompat.CheckSelfPermission(this, Permissions[0]);  
        if (status != Permission.Granted)  
        {  
            ActivityCompat.RequestPermissions(this, Permissions, REQUEST_PERMISSION_CODE);  
        }  
    }  
  
    //...
```

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

### Install the Barcode Scanner SDK

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

Run this command in your root project folder to install the plugin.

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

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

### Create Project Directory

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

Initializes the project folder and the main entry-point script.

```bash
mkdir -p barcode-quickstart-python && \  
touch barcode-quickstart-python/main.py  
```

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

### Verify Installation

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

Checks if the scanbotsdk package is correctly installed and importable.

```bash
python -c "import scanbotsdk; print('scanbotsdk OK')"  
```

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

### Install CUDA and TensorRT

Source: https://docs.scanbot.io/linux/barcode-scanner-sdk/scanning-barcodes-from-live-stream

Optional installation for GPU acceleration on supported hardware.

```bash
sudo apt install -y nvidia-l4t-cuda libnvinfer10 libnvinfer-plugin10 libnvonnxparsers10  
```

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

### Initialize the SDK

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

Import the SDK and initialize it with your license key.

```javascript
import ScanbotBarcodeSDK, { SdkConfiguration } from 'react-native-scanbot-barcode-scanner-sdk';
```

```javascript
ScanbotBarcodeSDK.initialize(new SdkConfiguration({ licenseKey: '' }))
  .then(result => console.log(result))
  .catch(err => console.log(err));
```

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

### Install Scanbot SDK

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

Installs the Scanbot SDK wheel file for specific architectures.

```bash
export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION>  
pip install https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv${SCANBOT_SDK_VERSION}/scanbotsdk-${SCANBOT_SDK_VERSION}-py3-none-linux_aarch64.whl  
```

```bash
export SCANBOT_SDK_VERSION=<SCANBOT_SDK_VERSION>  
pip install https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv${SCANBOT_SDK_VERSION}/scanbotsdk-${SCANBOT_SDK_VERSION}-py3-none-linux_x86_64.whl  
```

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

### Configure Build Phase Script

Source: https://docs.scanbot.io/ios/barcode-scanner-sdk/detailed-setup-guide/installing-the-sdk

Run script and input file paths for manual framework installation.

```bash
bash "$BUILT_PRODUCTS_DIR/$FRAMEWORKS_FOLDER_PATH/ScanbotBarcodeScannerSDK.framework/strip-SBSDK-Framework.sh"
```

```text
$(SRCROOT)/./ScanbotBarcodeScannerSDK/dSYMs/ScanbotBarcodeScannerSDK.framework.dSYM
```

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

### Install Pods via Terminal

Source: https://docs.scanbot.io/ios/barcode-scanner-sdk/detailed-setup-guide/installing-the-sdk

Command to install the specified pods and update the repository.

```bash
$ pod install --repo-update
```

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

### Initialize the SDK in MauiProgram.cs

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

Configure the SDK within the CreateMauiApp method. Without a valid license key, the SDK operates in a 60-second trial mode.

```csharp
using Microsoft.Extensions.Logging;  
using ScanbotSDK.MAUI;  
  
// Replace test_maui with the namespace of your app.  
namespace test_maui;  
  
public static class MauiProgram  
{  
    // Without a license key, the Scanbot Barcode SDK will work for 1 minute.  
    // To scan longer, register for a trial license key here: https://docs.scanbot.io/trial/  
    public const string LicenseKey = "";  
  
    public static MauiApp CreateMauiApp()  
    {  
        var builder = MauiApp.CreateBuilder();  
        builder  
            .UseMauiApp<App>()  
            .ConfigureFonts(fonts =>  
            {  
                fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");  
                fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");  
            });  
  
#if DEBUG  
        builder.Logging.AddDebug();  
#endif  
  
        ScanbotSDKMain.Initialize(new SdkConfiguration  
            {  
                LoggingEnabled = true,  
                LicenseKey = LicenseKey  
            }, builder);  
  
        return builder.Build();  
    }  
}  
```

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

### Configure and Launch Text Pattern Scanner

Source: https://docs.scanbot.io/android/data-capture-modules/text-pattern-scanner/ready-to-use-ui

Sets up the result launcher and configures the introduction screen properties before launching the scanner.

```kotlin
val resultLauncher: ActivityResultLauncher<TextPatternScannerScreenConfiguration> =  
    registerForActivityResult(TextPatternScannerActivity.ResultContract()) { resultEntity ->  
        resultEntity.onSuccess { result ->  
            Toast.makeText(this@TextPatternIntroductionSnippet, result.rawText, Toast.LENGTH_LONG)  
                .show()  
        }.onCancellation {  
            // Indicates that the cancel button was tapped. Or screen is closed by other reason.  
        }.onFailure {  
            // Optional activity closing cause handling to understand the reason scanner result is not provided  
            when (it) {  
                is Result.InvalidLicenseError -> {  
                    // indicate that the Scanbot SDK license is invalid  
                }  
  
                else -> {  
                    // Handle other errors  
                }  
            }  
        }  
    }  
  
private fun startScanning() {  
  
    // Create the default configuration object.  
    val configuration = TextPatternScannerScreenConfiguration()  
  
    // Retrieve the instance of the intro screen from the configuration object.  
    configuration.introScreen.apply {  
        // Show the introduction screen automatically when the screen appears.  
        showAutomatically = true  
  
        // Configure the background color of the screen.  
        backgroundColor = ScanbotColor("#FFFFFF")  
  
        // Configure the title for the intro screen.  
        title.text = "How to scan an text"  
  
        // Configure the image for the introduction screen.  
        // If you want to have no image...  
        image = TextPatternIntroNoImage()  
        // For a custom image...  
        image = TextPatternIntroCustomImage(uri = "PathToImage")  
        // Or you can also use our default image.  
        image = TextPatternIntroMeterDevice()  
  
        // Configure the color of the handler on top.  
        handlerColor = ScanbotColor("#EFEFEF")  
  
        // Configure the color of the divider.  
        dividerColor = ScanbotColor("#EFEFEF")  
  
        // Configure the text.  
        explanation.color = ScanbotColor("#000000")  
        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.  
        doneButton.text = "Start Scanning"  
        doneButton.background.fillColor = ScanbotColor("#C8193C")  
    }  
  
    resultLauncher.launch(configuration)  
}  
```

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

### Install the Scanbot SDK

Source: https://docs.scanbot.io/react-native/data-capture-modules/detailed-setup-guide/installing-the-sdk

Commands to install the SDK package using different package managers.

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

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

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

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

### Install Python and OpenCV

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

Installs the necessary Python environment and OpenCV library on an Ubuntu-based system.

```bash
sudo apt update  
sudo apt install -y python3-venv python3-opencv  
```

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

### Configure and launch the cropping UI screen

Source: https://docs.scanbot.io/react-native/document-scanner-sdk/scan-from-image/using-the-cropping-ui-screen

This example demonstrates selecting an image, creating a document, configuring the cropping UI appearance, and launching the screen.

```typescript
import {selectImagesFromLibrary} from '@utils';  
import {CroppingConfiguration, ScanbotDocument} from 'react-native-scanbot-sdk';  
  
async function startDocumentDetectionWithCroppingScreen() {  
  try {  
    /**  
     * Select an image from the Image Library  
     * Return early if no image is selected or there is an issue selecting an image  
     **/  
    const selectedImagesResult = await selectImagesFromLibrary();  
    if (!selectedImagesResult) {  
      return;  
    }  
    /** Create a new document with the provided imageFileUri. */  
    const document = await ScanbotDocument.createDocumentFromImages({  
      images: selectedImagesResult,  
    });  
    /** Create a new configuration with the document and the document's first page. */  
    const configuration = new CroppingConfiguration({  
      documentUuid: document.uuid,  
      pageUuid: document.pages[0].uuid,  
    });  
    /* Customize the configuration. */  
    configuration.cropping.bottomBar.rotateButton.visible = false;  
    configuration.appearance.topBarBackgroundColor = '#c8193c';  
    configuration.cropping.topBarConfirmButton.foreground.color = '#ffffff';  
    configuration.localization.croppingTopBarCancelButtonTitle = 'Cancel';  
    /** Start the cropping UI Screen */  
    const documentResult = await ScanbotDocument.startCroppingScreen(  
      configuration,  
    );  
    /** Handle the document if the status is 'OK' */  
    if (documentResult.status === 'OK') {  
    }  
  } catch (e: any) {  
    console.error(e.message);  
  }  
}  
```

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

### Install required packages

Source: https://docs.scanbot.io/linux/barcode-scanner-sdk/scanning-barcodes-from-live-stream

Install the necessary Python packages for the Scanbot SDK and OpenCV integration.

```bash
pip install scanbotsdk opencv-python numpy  
```

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

### Initialize SDK with Different API Styles

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

Comparison of standard callback-based, promise-based, and async/await initialization patterns.

```javascript
//------ Cordova-style call with callbacks ----------------  
ScanbotBarcodeSDK.initializeSdk(function(result) {  
  // success  
}, function(err) {  
  // error  
}, config);  
  
  
//---------- Promise-style with arrow functions -----------  
ScanbotBarcodeSDK.promisify().initializeSdk(config)  
.then(result => {  
  // success  
})  
.catch(err => {  
  // error  
});  
  
  
//---------- async/await style (recommended) --------------  
try {  
  const result = await ScanbotBarcodeSDK.promisify().initializeSdk(config);  
  // success  
} catch (err) {  
  // error  
}  
```

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

### Initialize the SDK

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

Initialize the SDK as soon as the app launches using your license key.

```typescript
ScanbotBarcodeSDK
  .initialize(new SdkConfiguration({ licenseKey: '' }))
  .then((result) => console.log(result))
  .catch((err) => console.log(err));
```

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

### Install Capacitor Plugin

Source: https://docs.scanbot.io/capacitor/data-capture-modules/detailed-setup-guide/installing-the-sdk

Run this command in the root folder of your project to install the Scanbot SDK plugin.

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

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

### Install packages via Flutter CLI

Source: https://docs.scanbot.io/flutter/barcode-scanner-sdk/detailed-setup-guide/installing-the-sdk

Run this command in your terminal to fetch and install the dependencies defined in your pubspec.yaml.

```bash
flutter pub get  
```
Tokens:
Raw