Go to the documentation of this file.
1 
10 #ifndef SC_RECOGNITION_CONTEXT_H_
11 #define SC_RECOGNITION_CONTEXT_H_
12 
13 #include <Scandit/ScConfig.h>
14 #include <Scandit/ScCommon.h>
16 
17 #if SC_PLATFORM_ANDROID
18 # include <jni.h>
19 #endif
20 
22 
38 typedef struct ScOpaqueRecognitionContext ScRecognitionContext;
41 
47 typedef enum {
229 
238 
240 
247 typedef struct {
249  uint32_t frame_id;
251 
259 SC_EXPORT
261 
262 #if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
263 
283 SC_EXPORT
284 ScRecognitionContext *sc_recognition_context_new(char const *license_key,
285  char const *writable_data_path,
286  JNIEnv *env,
287  jobject activity,
288  char const *device_name);
289 #endif
290 
291 #if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
292 
314 SC_EXPORT
315 ScRecognitionContext *sc_recognition_context_new(char const *license_key,
316  char const *writable_data_path,
317  char const *device_name);
318 #endif
319 
328 SC_EXPORT
330 
341 SC_EXPORT
343 
372 SC_EXPORT
374 
407 SC_EXPORT
409  ScRecognitionContext *context,
410  ScImageDescription const *image_description,
411  uint8_t const *image_data);
412 
424 SC_EXPORT
426 
434 typedef enum {
435  SC_CAMERA_FACING_DIRECTION_UNKNOWN = 0x00,
436  SC_CAMERA_FACING_DIRECTION_BACK = 0x01,
437  SC_CAMERA_FACING_DIRECTION_FRONT = 0x02
439 
446 typedef struct {
448  char const *identifier;
451 
463 SC_EXPORT
465  ScCameraProperties camera_properties);
466 
468 
469 #endif // SC_RECOGNITION_CONTEXT_H_
The Scandit SDK validation failed. The external id does not match with the license key...
Definition: ScRecognitionContext.h:174
Opaque recognition context data structure.
The context status is okay. No error occured.
Definition: ScRecognitionContext.h:55
The device activation failed. The number of allowed scans has exceeded.
Definition: ScRecognitionContext.h:160
Platform specific camera properties.
Definition: ScRecognitionContext.h:446
void sc_recognition_context_end_frame_sequence(ScRecognitionContext *context)
Signal that a batch of continuous frames ended.
Error code to indicate that sc_recognition_context_process_frame() was called without a prior call to...
Definition: ScRecognitionContext.h:65
The Scandit SDK validation failed. Your license key has expired. Please login to scandit.com and aquire a new one.
Definition: ScRecognitionContext.h:100
The license does not include the requested text recognizer.
Definition: ScRecognitionContext.h:208
Result status and frame id.
Definition: ScRecognitionContext.h:247
The provided image data has missing or inconsistent properties. This error code can for example indic...
Definition: ScRecognitionContext.h:76
Denotes the beginning of the enum range for unlicensed features.
Definition: ScRecognitionContext.h:228
void sc_recognition_context_set_camera_properties(ScRecognitionContext *context, ScCameraProperties camera_properties)
set the properties that define the camera that is to be used
ScContextStatusFlag
Context status of a frame.
Definition: ScRecognitionContext.h:47
void sc_recognition_context_start_new_frame_sequence(ScRecognitionContext *context)
Start processing a new batch of continuous frames.
Your license key's version is not compatible with this SDK version.
Definition: ScRecognitionContext.h:189
ScCameraFacingDirection
The direction of the camera. The default camera direction is SC_CAMERA_FACING_DIRECTION_UNKNOWN.
Definition: ScRecognitionContext.h:434
ScContextStatusFlag status
Execution status flag.
Definition: ScRecognitionContext.h:248
The registration of the device is mandatory and must be completed before the recognition context can ...
Definition: ScRecognitionContext.h:167
The context status is unknown.
Definition: ScRecognitionContext.h:51
Scandit SDK failed to get network access which is mandatory for certain license types. For example a test license.
Definition: ScRecognitionContext.h:83
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19
void sc_recognition_context_release(ScRecognitionContext *context)
Decrease reference count of recognition context by one.
char const * sc_context_status_flag_get_message(ScContextStatusFlag status)
Get a human readable error message for a result status.
Describes dimensions as well as internal memory layout of an image buffer.
char const * identifier
Default is NULL.
Definition: ScRecognitionContext.h:448
The device activation failed. The number of allowed days to use the SDK has exceeded.
Definition: ScRecognitionContext.h:153
ScProcessFrameResult sc_recognition_context_process_frame(ScRecognitionContext *context, ScImageDescription const *image_description, uint8_t const *image_data)
Process image frame with this recognition context.
The Scandit SDK validation failed. Your license key does not include support for this device...
Definition: ScRecognitionContext.h:124
The Scandit SDK validation failed. Your app ID does not match the license key's app ID...
Definition: ScRecognitionContext.h:116
The Scandit SDK license validation failed. Your license key does not include this platform...
Definition: ScRecognitionContext.h:108
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28
A missing resource made the scanning operation fail.
Definition: ScRecognitionContext.h:202
Denotes the end of the enum range for unlicensed features.
Definition: ScRecognitionContext.h:237
ScCameraFacingDirection facing_direction
The direction of the camera.
Definition: ScRecognitionContext.h:447
Scandit SDK validation failed. Make sure your app key is valid and check your account for available d...
Definition: ScRecognitionContext.h:88
The Scandit SDK validation failed. Your license key does not include support for this SDK version...
Definition: ScRecognitionContext.h:132
uint32_t frame_id
frame identification number within the current frame sequence
Definition: ScRecognitionContext.h:249
The context encountered an internal error.
Definition: ScRecognitionContext.h:59
Common definitions used throughout the ScanditSDK API.
Common functions and data structures.
The provided Scandit SDK license license key is invalid. Please set a valid license key in your appli...
Definition: ScRecognitionContext.h:139
Your license does not include a symbology extension enabled by your barcode scanner settings...
Definition: ScRecognitionContext.h:196
An error has occurred in the OCR module.
Definition: ScRecognitionContext.h:214
Your license does not include a symbology enabled by your barcode scanner settings.
Definition: ScRecognitionContext.h:181
ScRecognitionContext * sc_recognition_context_new(char const *license_key, char const *writable_data_path, JNIEnv *env, jobject activity, char const *device_name)
Create a new recognition context (Android only).
The device activation failed. Please connect to the Internet and restart the application.
Definition: ScRecognitionContext.h:146
Image description interface.
The provided image data is not supported by the recognition context.
Definition: ScRecognitionContext.h:69
No Scandit SDK license key was set. Please set a valid license key in your application.
Definition: ScRecognitionContext.h:93
void sc_recognition_context_retain(ScRecognitionContext *context)
Increase reference count of recognition context by one.