ScRecognitionContext.h File Reference

Go to the source code of this file.

Data Structures

struct  ScProcessFrameResult
 

Typedefs

typedef struct ScOpaqueRecognitionContext ScRecognitionContext
 

Enumerations

enum  ScContextStatusFlag {
  SC_RECOGNITION_CONTEXT_STATUS_UNKNOWN = 0, SC_RECOGNITION_CONTEXT_STATUS_SUCCESS = 1, SC_RECOGNITION_CONTEXT_STATUS_INTERNAL_ERROR = 2, SC_RECOGNITION_CONTEXT_STATUS_FRAME_SEQUENCE_NOT_STARTED = 3,
  SC_RECOGNITION_CONTEXT_STATUS_UNSUPPORTED_IMAGE_DATA = 4, SC_RECOGNITION_CONTEXT_STATUS_INCONSISTENT_IMAGE_DATA = 5, SC_RECOGNITION_CONTEXT_STATUS_NO_NETWORK_CONNECTION = 6, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_FILE_EXPIRED = 7,
  SC_RECOGNITION_CONTEXT_STATUS_LICENSE_FILE_IO_ERROR = 8, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED = 9, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED_400 = 10, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED_403 = 11,
  SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_MISSING = 12, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_EXPIRED = 13, SC_RECOGNITION_CONTEXT_STATUS_INVALID_PLATFORM = 14, SC_RECOGNITION_CONTEXT_STATUS_INVALID_APP_ID = 15,
  SC_RECOGNITION_CONTEXT_STATUS_INVALID_DEVICE = 16, SC_RECOGNITION_CONTEXT_STATUS_INVALID_SDK_VERSION = 17, SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_INVALID = 18, SC_RECOGNITION_CONTEXT_STATUS_DEVICE_ACTIVATION_FAILED = 19,
  SC_RECOGNITION_CONTEXT_STATUS_TIME_EXCEEDED = 20, SC_RECOGNITION_CONTEXT_STATUS_SCANS_EXCEEDED = 21, SC_RECOGNITION_CONTEXT_STATUS_REGISTRATION_MANDATORY_BUT_NOT_REGISTERED = 22, SC_RECOGNITION_CONTEXT_STATUS_INVALID_EXTERNAL_ID = 23,
  SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_SYMBOLOGY_ENABLED = 24, SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_RESOLUTION = 25, SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_BEGIN = 255, SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_END = 512
}
 

Functions

const char * sc_context_status_flag_get_message (ScContextStatusFlag status)
 

Detailed Description

Recognition context interface.


Data Structure Documentation

struct ScProcessFrameResult
Data Fields
ScContextStatusFlag status Execution status flag.
uint32_t frame_id frame identification number within the current frame sequence

Enumeration Type Documentation

Context status of a frame.

Since
4.6.0
Enumerator
SC_RECOGNITION_CONTEXT_STATUS_UNKNOWN 

The context status is unknown.

SC_RECOGNITION_CONTEXT_STATUS_SUCCESS 

The context status is okay. No error occured.

SC_RECOGNITION_CONTEXT_STATUS_INTERNAL_ERROR 

The context encountered an internal error.

SC_RECOGNITION_CONTEXT_STATUS_FRAME_SEQUENCE_NOT_STARTED 

Error code to indicate that sc_recognition_context_process_frame() was called without a prior call to sc_recognition_context_start_new_frame_sequence().

SC_RECOGNITION_CONTEXT_STATUS_UNSUPPORTED_IMAGE_DATA 

The provided image data is not supported by the recognition context.

SC_RECOGNITION_CONTEXT_STATUS_INCONSISTENT_IMAGE_DATA 

The provided image data has missing or inconsistent properties. This error code can for example indicate that the data buffer size of the provided image buffer is too small for the given combination of image dimensions and format.

SC_RECOGNITION_CONTEXT_STATUS_NO_NETWORK_CONNECTION 

Scandit SDK failed to get network access which is mandatory for certain license types. For example a test license.

Connect your device to the network, restart the application and try again.

SC_RECOGNITION_CONTEXT_STATUS_LICENSE_FILE_EXPIRED 

The Scandit SDK license file expired. Please obtain a new one.

Deprecated:
since 4.16.0
SC_RECOGNITION_CONTEXT_STATUS_LICENSE_FILE_IO_ERROR 

The Scandit SDK license file can not be found or accessed.

Deprecated:
since 4.16.0
SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED 

Scandit SDK validation failed. Check your license key and network connection.

SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED_400 

Scandit SDK detected a corrupted log and could not validate this installation.

SC_RECOGNITION_CONTEXT_STATUS_LICENSE_VALIDATION_FAILED_403 

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

SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_MISSING 

No Scandit SDK license key was set. Please set a valid license key in your application.

SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_EXPIRED 

The Scandit SDK validation failed. Your license key has expired. Please login to scandit.com and aquire a new one.

Since
4.16.0
SC_RECOGNITION_CONTEXT_STATUS_INVALID_PLATFORM 

The Scandit SDK license validation failed. Your license key does not include this platform. Please contact the Scandit support to request a different license key.

Since
4.16.0
SC_RECOGNITION_CONTEXT_STATUS_INVALID_APP_ID 

The Scandit SDK validation failed. Your app ID does not match the license key's app ID. Please change the app identifier of your app or acquire a new license key that matches your application identifier.

Since
4.16.0
SC_RECOGNITION_CONTEXT_STATUS_INVALID_DEVICE 

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

Since
4.16.0
SC_RECOGNITION_CONTEXT_STATUS_INVALID_SDK_VERSION 

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

Since
4.16.0
SC_RECOGNITION_CONTEXT_STATUS_LICENSE_KEY_INVALID 

The provided Scandit SDK license license key is invalid. Please set a valid license key in your application.

Since
5.1.0
SC_RECOGNITION_CONTEXT_STATUS_DEVICE_ACTIVATION_FAILED 

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

Since
5.6.0
SC_RECOGNITION_CONTEXT_STATUS_TIME_EXCEEDED 

The device activation failed. The number of allowed days to use the SDK has exceeded.

Since
5.9.0
SC_RECOGNITION_CONTEXT_STATUS_SCANS_EXCEEDED 

The device activation failed. The number of allowed scans has exceeded.

Since
5.9.0
SC_RECOGNITION_CONTEXT_STATUS_REGISTRATION_MANDATORY_BUT_NOT_REGISTERED 

The registration of the device is mandatory and must be completed before the recognition context can be used.

Since
5.9.0
SC_RECOGNITION_CONTEXT_STATUS_INVALID_EXTERNAL_ID 

The Scandit SDK validation failed. The external id does not match with the license key.

Since
5.9.0
SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_SYMBOLOGY_ENABLED 

Your license does not include a symbology enabled by your barcode scanner settings.

Since
5.11.0
SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_RESOLUTION 

Your license does not include the enabled resolution.

Since
6.0
SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_BEGIN 

Denotes the beginning of the enum range for unlicensed features.

When trying to use an unlicensed feature, the ScContextStatusFlag will be set to an enum in the range from SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_BEGIN to SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_END. The exact value depends on the unlicensed feature. To determine which feature is unlicensed, use sc_context_status_flag_get_message which will return a human-readable representation of the error.

Since
5.2.0
SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_END 

Denotes the end of the enum range for unlicensed features.

See also
SC_RECOGNITION_CONTEXT_STATUS_UNLICENSED_FEATURE_END
Since
5.2.0

Function Documentation

const char* sc_context_status_flag_get_message ( ScContextStatusFlag  status)

Get a human readable error message for a result status.

Parameters
statusrecognition context status flag
Returns
a constant string message
Since
4.12.0
Examples:
CommandLineBarcodeScannerCameraSample.c, CommandLineBarcodeScannerImageProcessingSample.c, and CommandLineMatrixScanCameraSample.c.