Installation
This guide shows you how to add the Scandit Data Capture SDK to current existing project.
Prerequisites
- The latest stable version of Visual Studio.
- A .NET SDK.
- A .NET for iOS project with minimum iOS deployment target of 13.0 or higher. Or a .NET for Android project with target SDK version 23 (Android 6, Marshmallow) or higher.
- A valid Scandit Data Capture SDK license key. You can sign up for a free test account.
Android devices running the Scandit Data Capture SDK need to have a GPU or the performance will drastically decrease.
Get a License Key
If you have a paid subscription, please reach out to Scandit Support if you need a new license key.
Add the SDK
The Scandit Data Capture SDK is distributed as NuGet packages.
You will always need to add the Scandit.DataCapture.Core package, which contains the core functionality used by the other data capture packages. When developing MAUI applications you will also need to add the Scandit.DataCapture.Core.Maui package.
In addition, depending on the data capture task, you will need a reference to:
| Functionality | Description | Required Module(s) |
|---|---|---|
| Barcode Capture | ScanditBarcodeCapture API if you want to use barcode-related functionality, such as barcode capture or MatrixScan. | com.scandit.datacapture:barcode |
| Parser | ScanditParser API if you want to parse data strings, for instance, as found in barcodes, into a set of key-value mappings. | com.scandit.datacapture:parser |
| ID Capture | ScanditIdCapture API if you want to scan personal identification documents, such as identity cards, passports or visas. | com.scandit.datacapture:id |
You can safely remove Scandit.DataCapture.Barcode, Scandit.DataCapture.Parser, or Scandit.DataCapture.IdCapture dependencies if you are not going to use their features.
Additional Information
On Android, the Scandit SDK uses content providers to initialize the scanning capabilities properly. If your own content providers depend on the Scandit SDK, choose an initOrder lower than 10 to make sure the SDK is ready first.
If not specified, initOrder is zero by default and you have nothing to worry about.
Camera Permissions
When using the Scandit Data Capture SDK you will want to set the camera as the frame source for various capture modes. On .NET for Android or MAUI, you have to request camera permissions in your own application before starting scanning. To see how you can achieve this, take a look at our samples.