Add the SDK to Your App#

This guide shows you how to add the Scandit Data Capture SDK to current existing project.

Prerequisites#

Note

Android devices running the Scandit Data Capture SDK need to have a GPU or the performance will drastically decrease.

Get a License Key#

  1. If you don’t have a Scandit account yet, create a free test account at ssl.scandit.com.

  2. Sign in to your account at ssl.scandit.com/sessions/new.

  3. Select “License Keys” from the left-hand menu.

  4. If you don’t have a license key for your app yet, click “Create native SDK license key” and enter the bundle ID for your project.

  5. Copy the license key.

If you have a paid subscription, please reach out to support@scandit.com if you need a new license key.

Add the SDK#

Currently we support adding the Scandit Data Capture SDK Titanium modules to your project in two ways. The simplest way is to use the npm registry, alternatively you can manually download the modules and add them to your project.

1. Create a new project (optional)#

If you do not have a Titanium project yet that you’ll use, you should create a new one.

> ti create -t app -n <PROJECT_NAME>

2a. Add the Scandit Data Capture SDK from the npm registry#

To add our plugins from the npm registry, you can run these commands from your project’s root folder. In the following snippet we’re adding ScanditBarcodeCapture API

npm install scandit-titanium-datacapture-core
npm install scandit-titanium-datacapture-barcode

Note

You can also specify a version @<version>.

2b. Add the Scandit Data Capture SDK manually#

You need to declare the modules you want to use in the app’s tiapp.xml file, e.g. for barcode capture, declare the scandit-titanium-datacapture-barcode module:

<modules>
  <module platform="android">com.scandit.ti.datacapture.core</module>
  <module platform="android">com.scandit.ti.datacapture.barcode</module>
  <module platform="iphone">com.scandit.ti.datacapture.barcode</module>
  <module platform="iphone">com.scandit.ti.datacapture.core</module>
</modules>

After you download the archive containing all the modules at ssl.scandit.com/sdk, unzip the archive. It includes the available Titanium modules, including the scandit-titanium-datacapture-core module that all other modules depend on. Now you need to copy the the reqired modules to the root folder of the application. Sticking with the current example, it means that you need to copy:

  • The barcode module for Android.

  • The core module for Android.

  • The barcode module for iOS.

  • The core module for iOS.

Additional Information#

  • 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 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: Run our Sample Apps.

  • Remember that, if you want to use the camera as the frame source for barcode capture you need to set the “Privacy - Camera Usage Description” field in the Info.plist file for iOS.

Next steps#

You are now ready to tackle the following guides: