Installation Guide for the barKoder Barcode Scanner SDK plugin for Xamarin

Following is the guide for utilizing the the barKoder Xamarin Plugin. Follow the simple steps below to use the barKoder SDK in your Xamarin project:

1. Add our Barkoder.Xamarin nuget package from source "nuget.org" #

2. Import package #

                using Barkoder.Xamarin;
            

3. Camera permission #

Our SDK requires camera permission to be granted in order to use scanning features. For Android, the permission is set in the manifest from the package. For iOS you need to specify camera permission in Info.plist file inside your project

                <key>NSCameraUsageDescription</key>
<string>Camera permission</string>
            

4. Add BarkoderView #

                private BarkoderView BkdView;
            

4.1 Android #

                BkdView = FindViewById<BarkoderView>(Resource.Id.barkoderView);
            

4.2 iOS #

                BkdView = new BarkoderView();
var barkoderView = BkdView.View;

BkdView = new BarkoderView();
var BarkoderView = BkdView.View;
View.AddSubview(BarkoderView);

...

// TODO: Add constraints to BarkoderView
            

Both #

                // In order to perform scanning, config property need to be set before

BkdView.Config = new BarkoderConfig("LICENSE_KEY");
BkdView.Config.DecoderConfig = new DecoderConfig();
            

6. Optional barkoder settings #

General barcode settings #

                private void SetBarkoderSettings()
{
    // These are optional settings, otherwise default values will be used
    BkdView.Config.ImageResultEnabled = true;
    BkdView.Config.LocationInImageResultEnabled = true;
    BkdView.Config.RegionOfInterestVisible = true;
}
            

6.1 Barcode types iOS #

                private void SetActiveBarcodeTypes()
{
    /// There is option to set multiple active barcodes at once as array
    BkdView.Config.DecoderConfig.SetEnabledDecoders(
        new NSNumber[] {
            (int)DecoderType.Qr,
            (int)DecoderType.Ean13
        }
    );

    // or configure them one by one
    BkdView.Config.DecoderConfig.UpcA.Enabled = true;
}
            

6.2 Barcode types Android #

                private void SetActiveBarcodeTypes()
{
    /// There is option to set multiple active barcodes at once as array
    BkdView.Config.DecoderConfig.SetEnabledDecoders(
        new BKD.DecoderType[] {
            BKD.DecoderType.Qr,
            BKD.DecoderType.Ean13
        }
    );

    // or configure them one by one
    BkdView.Config.DecoderConfig.UpcA.Enabled = true;
}
            

7. Ready to Scan Event #

Inside MethodResultCallBackDecoderResultWithCompletion callback function the SDK is fully initialized and ready for configuration or to start the scanning process

7.1 Start scanning iOS #

                // Starting to scan
BkdView.StartScanning((result) =>
    // Fetching data
    // TODO: Getting results
);
            

7.2 Start scanning Android #

                // Starting to scan
BkdView.StartScanning(this);

// Fetching data
public void ScanningFinished(BKD.Result[] results, Bitmap resultImage)
{
    // TODO: Getting results
}
            

8. Licensing #

The SDK will scan barcodes even without a valid license; however all results will be randomly masked with (*) Asterisk characters. By using our software you are agreeing to our End User License Agreement. To obtain a valid license, one should create an account here and either get a trial license (to test the software out) or procure a production license that can be used within a production build.