Context Status

Defined under the namespace Scandit.Datacapture.Core

ContextStatus
class ContextStatus

Added in version 6.1.0

Holds information on the current context status. This information is available to data capture context listeners (see didChangeStatus() method). The initial context status will always be Unknown (0) but change very quickly to either Success (1) or an error (2+, see below).

message
get message(): string

Added in version 6.1.0

A human readable representation of the current context status, containing more information about potential issues. In case there are no issues (isValid is true), the message is empty.

code
get code(): number

Added in version 6.1.0

The context status code.

isValid
get isValid(): boolean

Added in version 6.1.0

Whether the context is valid.

Status Codes

0 - Unknown

The context was just created and the current status is not yet known.

1 - Success

Everything is working as expected.

2 - Internal Error

Something went wrong internally. Please send the error, device model and Scandit Data Capture SDK version through this contact form.

5 - Inconsistent Image Data

The image data being fed to the recognizer is inconsistent. This is likely a device issue. Please send the error, device model and Scandit Data Capture SDK version through this contact form.

6 - No Network Connection

You are using a test license of the Scandit Data Capture SDK which needs a network connection to scan. Please make sure the phone you are testing on is connected to the Internet (an intra net for example might not have a connection to the public Internet).

9, 10, 11 - Validation Failed

The license key validation failed. Make sure you are using a valid license key and check your account for available device activations. If this doesn’t fix the problem, please send the error, device model and Scandit Data Capture SDK version through this contact form.

12 - License Key Missing

No License key was set. Please set a valid license key when creating your DataCaptureContext.

13 - License Key Expired

The license key validation failed. Your license key has expired, please log into your account at www.scandit.com and request an extension or contact support through this contact form.

14 - Invalid Platform

The license key validation failed. Your license key does not include the platform that you are using it on. Please contact support through this contact form to request a different license key.

15 - Invalid App ID

The license key validation failed. The identifier of your app does not match the license key’s app identifier. Please change the app identifier of your app or acquire a new license key that matches it.

16 - Invalid Device

The license key validation failed. Your license key does not include support for this device. Please contact support through this contact form to request a different license key.

17 - Invalid SDK Version

The license key validation failed. Your license key does not include support for this SDK version. Please contact support through this contact form to request a different license key.

18 - Invalid License Key

The provided license key is invalid. Please set a valid license key when creating your DataCaptureContext.

19 - Device Activation Failed

The device activation failed. Please connect to the Internet and restart the app.

20 - Time Exceeded

The device activation failed. The number of allowed days to use the SDK has exceeded. Please contact support through this contact form to request a different license key.

21 - Scans Exceeded

The device activation failed. The number of allowed scans was exceeded. Please contact support through this contact form to request a different license key.

22 - Mandatory Registration Not Completed

The registration of the device is mandatory and must be completed before the recognition context can be used. Please connect to the Internet and restart the app.

23 - Invalid External ID

The Scandit SDK validation failed. The external id does not match with the license key. Make sure you are setting the right external ID when creating your DataCaptureContext or no external ID at all if your license key is not meant for it.

24 - Unlicensed Symbology Enabled

Your license does not include a symbology that was enabled through barcode capture, tracking, selection or count settings. Please disable those symbologies or contact support through this contact form to request a license key containing the symbologies.

25 - Unlicensed Video Resolution

Your license does not include the enabled resolution. Please set a different VideoResolution or contact support through this contact form to request a license key with higher resolutions enabled.

26 - Invalid License Key Version

Your license key’s version is not compatible with this SDK version. Please contact support through this contact form to request a different license key.

27 - Unlicensed Symbology Extension Enabled

Your license does not include a symbology extension that was enabled through barcode capture, tracking, selection or count settings. Please disable those extensions or contact support through this contact form to request a license key containing the symbology extension.

28 - Missing Resource

A missing resource made the scanning operation fail. Please send the error, device model and Scandit Data Capture SDK version through this contact form.

29 - Unlicensed Text Recognizer

The license does not contain the requested text recognizer. Please send the error, device model and Scandit Data Capture SDK version through this contact form.

1025 - Disposed Context

The data capture context has been disposed and cannot be used anymore. Most likely this is happening because a new context was created but the old context is still used in some fashion. To solve this you should no longer use the old context once you create a new one or not re-create the context at all. Please read up on the data capture context to understand how exactly it behaves.

1026 - Augmented Reality Features Disabled

Your license does not include Augmented Reality functionality. Please contact support through this contact form if you would like to use this feature.

1028 - Conflicting Requirements

The added data capture modes have conflicting feature requirements and cannot be used with the same context at the same time. Read up on the conflicting requirements at DataCaptureContext.addMode().

1032 - Camera Authorization Required

The Scandit Data Capture SDK was unable to access the device’s camera. Check that your app has permissions to use the camera. In rare cases it is possible that the camera is locked by another app or non-functional because of some other reason, in such cases restarting the phone helps.

1040 - ID Capture Feature Disabled

Your license does not include ID Capture functionality. Please contact support through this contact form if you would like to use this feature.

1056 - Invalid Signature

Your license does not match the signature used to sign the binary.

1088 - Parser Feature Disabled

Your license does not include Parser functionality. Please contact support through this contact form if you would like to use this feature.

1152 - Parser for ID Capture Feature Disabled

Your license does not include ID Capture with Parser functionality. Please contact support through this contact form if you would like to use this feature.

1280 - Barcode for ID Capture Feature Disabled

Your license does not include ID Capture with Barcode Scanning functionality. Please contact support through this contact form if you would like to use this feature.

1536 - Barcode Feature Disabled

Your license does not include Barcode Scanning functionality. Please contact support through this contact form if you would like to use this feature.

2048 - OCR Disabled

Your license does not include OCR functionality. Please contact support through this contact form if you would like to use this feature.

3072 - Missing correct OCR License Key in ID Capture

Your license does not include the ID Capture with OCR functionality. Please contact support through this contact form if you would like to use this feature.

5120 - Barcode Selection Disabled

Your license does not include Barcode Selection functionality. Please contact support through this contact form if you would like to use this feature.

9216 - Barcode Tap Selection Disabled

Your license does not include Barcode Tap Selection functionality. Please contact support through this contact form if you would like to use this feature.

17408 - Selected settings have conflicting requirements and cannot be used at the same time

Using Mrz and VIZ scanning is not supported currently.

33793 - SparkScan Disabled

Your license does not include SparkScan functionality. Please contact support through this contact form if you would like to use this feature.

33794 - Camera Runtime Error

The camera was stopped because of a runtime error but it is not clear what the underlying cause is. Please contact support through this contact form such that the error case can be investigated and fixed in a future release.

131074 to 131671 - Network or Subscription Error

Depending on the license type the error is:

  • Test license: The Scandit SDK failed to get network access which is mandatory for this license. Connect your device to the network and restart the app.

  • Production license: The Scandit SDK validation failed. Make sure your license key is valid and check your account for available device activations.

131671 to 131680 - Subscription Error

The Scandit SDK validation failed. Make sure your license key is valid and check your account for available device activations.