Installation
This page describes how to integrate the Scandit Data Capture SDK into your Xamarin Android project.
Prerequisites
- The latest stable version of Visual Studio.
- A Xamarin.iOS project with minimum iOS deployment target of 14.0 or higher. Or a Xamarin.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.Xamarin package, which contains the core functionality used by the other data capture packages. In addition, depending on the data capture task, you will need a reference to:
- Scandit.DataCapture.Barcode.Xamarin (ScanditBarcodeCapture API) if you want to use barcode-related functionality such as barcode capture or MatrixScan.
- Scandit.DataCapture.Parser.Xamarin (ScanditParser API) if you want to parse data strings, e.g. as found in barcodes, into a set of key-value mappings.
You can safely remove Scandit.DataCapture.Barcode.Xamarin
, Scandit.DataCapture.Parser.Xamarin
dependencies if you are not going to use their features.
Additional Information
Content Providers
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.
Check the official <provider>
documentation.
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 Xamarin.Android, 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.
Third-party Licenses
The Scandit Data Capture SDK relies on several third-party, open-source software libraries. Your application must display the license information for these libraries in many cases.
The Scandit SDK provides a convenient API that you can use to fetch the corresponding text and attributions for all third-party software:
DataCaptureContext.openSourceSoftwareLicenseInfo()