ScRecognitionContext.h
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 
21 #if defined(__cplusplus)
22 extern "C" {
23 #endif
24 
40 typedef struct ScOpaqueRecognitionContext ScRecognitionContext;
43 
49 typedef enum {
261 
270 
272 
279 typedef struct {
281  uint32_t frame_id;
283 
291 SC_EXPORT
293 
294 #if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
295 
315 SC_EXPORT
316 ScRecognitionContext *sc_recognition_context_new(char const *license_key,
317  char const *writable_data_path,
318  JNIEnv *env,
319  jobject activity,
320  char const *device_name);
321 #endif
322 
323 #if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
324 
350 SC_EXPORT
351 ScRecognitionContext *sc_recognition_context_new(char const *license_key,
352  char const *writable_data_path,
353  char const *device_name);
354 #endif
355 
364 SC_EXPORT
366 
377 SC_EXPORT
379 
408 SC_EXPORT
410 
443 SC_EXPORT
445  ScRecognitionContext *context,
446  ScImageDescription const *image_description,
447  uint8_t const *image_data);
448 
460 SC_EXPORT
462 
472 SC_EXPORT
474  float latitude,
475  float longitude);
476 
484 typedef enum {
485  SC_CAMERA_FACING_DIRECTION_UNKNOWN = 0x00,
486  SC_CAMERA_FACING_DIRECTION_BACK = 0x01,
487  SC_CAMERA_FACING_DIRECTION_FRONT = 0x02
489 
496 typedef struct {
498  char const *identifier;
501 
513 SC_EXPORT
515  ScCameraProperties camera_properties);
516 
517 #if defined(__cplusplus)
518 }
519 #endif
520 
521 #endif // SC_RECOGNITION_CONTEXT_H_
Your license does not include the enabled resolution.
Definition: ScRecognitionContext.h:215
The Scandit SDK validation failed. The external id does not match with the license key...
Definition: ScRecognitionContext.h:202
Opaque recognition context data structure.
The context status is okay. No error occured.
Definition: ScRecognitionContext.h:57
The device activation failed. The number of allowed scans has exceeded.
Definition: ScRecognitionContext.h:188
Platform specific camera properties.
Definition: ScRecognitionContext.h:496
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:67
The Scandit SDK validation failed. Your license key has expired. Please login to scandit.com and aquire a new one.
Definition: ScRecognitionContext.h:128
The license does not include the requested text recognizer.
Definition: ScRecognitionContext.h:240
Result status and frame id.
Definition: ScRecognitionContext.h:279
The provided image data has missing or inconsistent properties. This error code can for example indic...
Definition: ScRecognitionContext.h:78
Denotes the beginning of the enum range for unlicensed features.
Definition: ScRecognitionContext.h:260
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:49
void sc_recognition_context_set_geographical_location(ScRecognitionContext *context, float latitude, float longitude)
Set the geographical location as coordinates.
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. Please contact Scandit support to...
Definition: ScRecognitionContext.h:221
ScCameraFacingDirection
The direction of the camera. The default camera direction is SC_CAMERA_FACING_DIRECTION_UNKNOWN.
Definition: ScRecognitionContext.h:484
ScContextStatusFlag status
Execution status flag.
Definition: ScRecognitionContext.h:280
The registration of the device is mandatory and must be completed before the recognition context can ...
Definition: ScRecognitionContext.h:195
The context status is unknown.
Definition: ScRecognitionContext.h:53
The Scandit SDK license file can not be found or accessed.
Definition: ScRecognitionContext.h:97
Scandit SDK failed to get network access which is mandatory for certain license types. For example a test license.
Definition: ScRecognitionContext.h:85
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:498
The device activation failed. The number of allowed days to use the SDK has exceeded.
Definition: ScRecognitionContext.h:181
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:152
The Scandit SDK validation failed. Your app ID does not match the license key's app ID...
Definition: ScRecognitionContext.h:144
The Scandit SDK license validation failed. Your license key does not include this platform...
Definition: ScRecognitionContext.h:136
Scandit SDK validation failed. Check your license key and network connection.
Definition: ScRecognitionContext.h:104
A missing resource made the scanning operation fail.
Definition: ScRecognitionContext.h:234
Denotes the end of the enum range for unlicensed features.
Definition: ScRecognitionContext.h:269
ScCameraFacingDirection facing_direction
The direction of the camera.
Definition: ScRecognitionContext.h:497
Scandit SDK detected a corrupted log and could not validate this installation.
Definition: ScRecognitionContext.h:111
Scandit SDK validation failed. Make sure your app key is valid and check your account for available d...
Definition: ScRecognitionContext.h:116
The Scandit SDK validation failed. Your license key does not include support for this SDK version...
Definition: ScRecognitionContext.h:160
uint32_t frame_id
frame identification number within the current frame sequence
Definition: ScRecognitionContext.h:281
The context encountered an internal error.
Definition: ScRecognitionContext.h:61
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:167
Your license does not include a symbology extension enabled by your barcode scanner settings...
Definition: ScRecognitionContext.h:228
An error has occurred in the OCR module.
Definition: ScRecognitionContext.h:246
Your license does not include a symbology enabled by your barcode scanner settings.
Definition: ScRecognitionContext.h:209
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 Scandit SDK license file expired. Please obtain a new one.
Definition: ScRecognitionContext.h:91
The device activation failed. Please connect to the Internet and restart the application.
Definition: ScRecognitionContext.h:174
Image description interface.
The provided image data is not supported by the recognition context.
Definition: ScRecognitionContext.h:71
No Scandit SDK license key was set. Please set a valid license key in your application.
Definition: ScRecognitionContext.h:121
void sc_recognition_context_retain(ScRecognitionContext *context)
Increase reference count of recognition context by one.