Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

BarcodePickerExternalActivity Class Reference

Inherits BarcodePickerActivity.

Public Member Functions

void didScan (ScanSession session)

Protected Member Functions

void setupScanUIFromIntent (BarcodePicker picker, Intent intent)
void buildSuccessResult (Intent resultIntent, ScanSession session)
void buildCancelResult (Intent resultIntent)

Detailed Description

Barcode Picker Activity that can be configured through an intent by passing an app key as well as a secondary app key.

Sample Usage

The following code shows how to start the BarcodePickerActivity to scan a retail code (UPCA, EAN13, EAN8, UPCE):

Intent launchIntent = new Intent(MyActivity.this, BarcodePickerActivity.class);
launchIntent.putExtra("appKey", "Your Scandit BarcodeScanner App Key Goes Here");
launchIntent.putExtra("secondaryAppKey", "Your secondary Scandit BarcodeScanner App Key Goes Here");
launchIntent.putExtra("enabledSymbologies", new int[] {
// start activity and listen for result.
startActivityForResult(launchIntent, 42);

Member Function Documentation

void setupScanUIFromIntent ( BarcodePicker  picker,
Intent  intent 

Uses the configuration options in the intent to setup the scan UI.

You can override this method to further customize the scan UI.

pickerthe picker to configure.
intentthe intent used to launch the activity.
void didScan ( ScanSession  session)

Called whenever a new barcode has been successfully recognized.

Newly recognized codes are available as ScanSession.getNewlyRecognizedCodes(). When didScan callback is invoked, there is always at least one new code available.

The callback is invoked in the thread running the barcode recognition engine. This means, any change to the graphical user interface will have to be moved to the UI thread. Likewise, Since the callback blocks the engine, any expensive calculation should be posted to a Handler.

When no more codes should be scanned, call ScanSession.stopScanning, when the scan session should be paused, call ScanSession.pauseScanning. Calling these two methods is preferred over calling BarcodePicker.stopScanning and BarcodePicker.pauseScanning, as it will immediately stop/pause the scanning.

Note, it is only safe to access the session object inside the didScan callback, but you can safely store the lists of barcodes returned by ScanSession.getAllRecognizedCodes and ScanSession.getNewlyRecognizedCodes

sessioncurrent scan session
See also

Implements OnScanListener.

void buildSuccessResult ( Intent  resultIntent,
ScanSession  session 

Builds the intent result in case of a successful scan.

You can override this method to customize the intent the activity returns. This function is not called on the main thread, UI operations can therefore not be performed.

resultIntentThe intent which will be returned as the result.
sessionThe scan session of the successful scan.
void buildCancelResult ( Intent  resultIntent)

Builds the intent result in case of the user canceling the activity.

You can override this method to customize the intent the activity returns.

resultIntentThe intent which will be returned as the result.

The documentation for this class was generated from the following file: