Functions of the Image Scanner SDK

Android

The Android API contains a method to decode and view the results of the static images in the Image Scanner SDK.

Image Decoding Method

The following method decodes the QR code in the image once it is detected:

public static QRCodeScannerSDKDecodingResultData decodeImage(Image image, int codeType) throws QRCodeScannerSDKException, LinkageError

Obtain Decoding Results

After decoding the QR code in the image, the QRCodeScannerSDKDecodingResultData obtains the results of the scan with the following methods:

public int getScannedImageFormat()

public String getScannedImageData()

Functions for Android [Deprecated]

The Android API consists of the QRCodeScannerSDKActivity class, which manages the behavior of the Image Scanner SDK.

The Android API returns a result code to indicate if a scan has been successful.

Display the scan result [Deprecated]

When a code is flashed, the QRcodeScannerSDKActivity class ends the scan process, and the activity is closed with the following code:

resultCode == RESULT_OK

The scan result will be transmitted with the OUTPUT_RESULT key.

Cancel the scan process [Deprecated]

When the back button is pressed, the QRCodeScannerSDKActivity instance is closed with the following code:

resultCode == RESULT_CANCELED

Exception [Deprecated]

If an error occurs, the caught exception is converted to a QRCodeScannerSDKException object. The QRCodeScannerSDKActivity ends the process and returns the following code:

resultCode == RESULT_ERROR

The result of the scan will be transmitted with the OUTPUT_EXCEPTION key.

QRCodeScannerSDKConstants [Deprecated]

The QRCodeScannerSDKConstants class contains the constants. The following table lists the available constants and parameters.

Properties

Example [Deprecated]

public void OnScanClicked(View v)
{
  ..
  // We want a vibration feedback after scanning
  // Note that the vibration feedback is activated by default
  intent.putExtra(QRCodeScannerSDKConstants.EXTRA_VIBRATE, true);
 
  // Indicate which sort of image we want to scan
  intent.putExtra(QRCodeScannerSDKConstants.EXTRA_CODE_TYPE, QRCodeScannerSDKConstants.QR_CODE +  QRCodeScannerSDKConstants.CRONTO_CODE);
 
  // Launch Image Scanner activity
  startActivityForResult(intent, 1);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data)
{
  switch (resultCode)
  {
    case RESULT_OK:
      ..
      String result = data.getStringExtra (QRCodeScannerSDKConstants.OUTPUT_RESULT);
      int codeType = data.getIntExtra (QRCodeScannerSDKConstants.OUTPUT_CODE_TYPE, 0);
 
      // Convert the result
      if (codeType == QRCodeScannerSDKConstants.CRONTO_CODE)
      {
        // we have scan a cronto code => convert the hexa string to string
        byte[] tmp = hexaToBytes(result);
        ..
      }
      else if (codeType == QRCodeScannerSDKConstants.QR_CODE)
      {
        // we have scanned a QR code => display directly the result
        resultTextView.setText(result);
        ..
      }
  }
}

Known issue with Samsung Galaxy A23

Due to a known issue with the camera on Samsung Galaxy A23, Cronto codes are not decoded properly with the default resolution. The solution to this issue is to increase the resolution using the following code snippet:

var imageAnalysisBuilder = ImageAnalysis.Builder().setTargetRotation(rotation)
// Set Resolution property only for Samsung Galaxy A23 model
if(Build.MANUFACTURER.equals("Samsung", true) && Build.MODEL.contains("A23")) {
         imageAnalysisBuilder.setTargetResolution(Size(1080, 1920))
}
imageAnalysisBuilder.build().setAnalyzer(cameraExecutor, QrCodeAnalyzer())

iOS

The iOS API contains a method to decode and view the results of the static images in the Image Scanner SDK.

Image Decoding Method

The following method decodes the QR code in the image once it is detected.

In Objective-C:

+ (QRCodeScannerSDKDecodingResultData * _Nullable)decodeImage:(UIImage *)image ofType:(int)codeType error:(NSError ** _Nullable)error;

In Swift:

public static func decodeImage(_ image: UIImage, codeType: CodeType) throws -> QRCodeScannerSDKDecodingResultData

Obtain Decoding Results

After decoding the QR code in the image, the QRCodeScannerSDKDecodingResultData obtains the results of the scan. The result contains the following fields.

In Objective-C:

int codeType;

NSString *result;

In Swift:

var codeType: CodeType

var result: String

Functions for iOS

public class QRCodeScannerSDK { 
public static func getQRCodeScannerSDKViewController(delegate: ScannerDelegate, vibrate: Bool, codeType: CodeType, image: UIImage?) throws -> UIViewController
public static func getQRCodeScannerSDKViewController(delegate: ScannerDelegate, vibrate: Bool, codeType: CodeType, image: UIImage?, scannerOverlay: Bool, scannerOverlayColor: UIColor?) throws -> UIViewController
public static var version: String
}

CodeType.qrCode
CodeType.crontoCode
CodeType.all

QRCodeScannerSDKConstants

The QRCodeScannerSDKConstants file contains the constant, fixed values for the Image Scanner SDK in iOS.

Properties