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 {
182 
195 
204 
206 
213 typedef struct {
215  uint32_t frame_id;
217 
225 SC_EXPORT const char *
227 
228 
229 #if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
230 
250 SC_EXPORT ScRecognitionContext *
251 sc_recognition_context_new(const char *license_key, const char* writable_data_path,
252  JNIEnv *env, jobject activity, const char* device_name);
253 #endif
254 
255 #if SC_PLATFORM_IOS || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
256 
273 SC_EXPORT ScRecognitionContext *
274 sc_recognition_context_new(const char *license_key, const char* device_name);
275 #endif
276 
277 #if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
278 
304 SC_EXPORT ScRecognitionContext *
305 sc_recognition_context_new(const char *license_key,
306  const char *writable_data_path,
307  const char *device_name);
308 #endif
309 
318 SC_EXPORT void sc_recognition_context_retain(ScRecognitionContext *context);
319 
331 
360 SC_EXPORT void
362 
395 SC_EXPORT ScProcessFrameResult
397  const ScImageDescription *image_description,
398  const uint8_t *image_data);
399 
411 SC_EXPORT void
413 
429 SC_EXPORT void
431  float latitude, float longitude);
432 
433 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
434 #include <UIKit/UIKit.h>
435 
455 SC_EXPORT ScContextStatusFlag
457  UIImage *image);
458 
459 #endif
460 
461 #if defined(__cplusplus)
462 }
463 #endif
464 
465 #endif // SC_RECOGNITION_CONTEXT_H_
The Scandit SDK validation failed. The external id does not match with the license key...
Definition: ScRecognitionContext.h:181
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:170
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:66
The Scandit SDK validation failed. Your license key has expired. Please login to scandit.com and aquire a new one.
Definition: ScRecognitionContext.h:117
Result status and frame id.
Definition: ScRecognitionContext.h:213
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:194
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.
void sc_recognition_context_start_new_frame_sequence(ScRecognitionContext *context)
Start processing a new batch of continuous frames.
ScContextStatusFlag sc_recognition_context_process_image(ScRecognitionContext *context, UIImage *image)
Process image frame with this recognition context.
ScRecognitionContext * sc_recognition_context_new(const char *license_key, const char *writable_data_path, JNIEnv *env, jobject activity, const char *device_name)
Create a new recognition context (Android only).
ScContextStatusFlag status
Execution status flag.
Definition: ScRecognitionContext.h:214
The registration of the device is mandatory and must be completed before the recognition context can ...
Definition: ScRecognitionContext.h:176
The context status is unknown.
Definition: ScRecognitionContext.h:53
The Scandit SDK license file can not be found or accessed.
Definition: ScRecognitionContext.h:94
Scandit SDK failed to get network access which is mandatory for certain license types. For example a test license.
Definition: ScRecognitionContext.h:82
void sc_recognition_context_release(ScRecognitionContext *context)
Decrease reference count of recognition context by one.
Describes dimensions as well as internal memory layout of an image buffer.
The device activation failed. The number of allowed days to use the SDK has exceeded.
Definition: ScRecognitionContext.h:164
const char * sc_context_status_flag_get_message(ScContextStatusFlag status)
Get a human readable error message for a result status.
The Scandit SDK validation failed. Your license key does not include support for this device...
Definition: ScRecognitionContext.h:139
The Scandit SDK validation failed. Your app ID does not match the license key's app ID...
Definition: ScRecognitionContext.h:132
The Scandit SDK license validation failed. Your license key does not include this platform...
Definition: ScRecognitionContext.h:124
Scandit SDK validation failed. Check your license key and network connection.
Definition: ScRecognitionContext.h:98
Denotes the end of the enum range for unlicensed features.
Definition: ScRecognitionContext.h:203
Scandit SDK detected a corrupted log and could not validate this installation.
Definition: ScRecognitionContext.h:102
Scandit SDK validation failed. Make sure your app key is valid and check your account for available d...
Definition: ScRecognitionContext.h:106
The Scandit SDK validation failed. Your license key does not include support for this SDK version...
Definition: ScRecognitionContext.h:146
uint32_t frame_id
frame identification number within the current frame sequence
Definition: ScRecognitionContext.h:215
The context encountered an internal error.
Definition: ScRecognitionContext.h:61
Common definitions used throughout the ScanditSDK API.
ScProcessFrameResult sc_recognition_context_process_frame(ScRecognitionContext *context, const ScImageDescription *image_description, const uint8_t *image_data)
Process image frame with this recognition context.
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:152
The Scandit SDK license file expired. Please obtain a new one.
Definition: ScRecognitionContext.h:88
The device activation failed. Please connect to the Internet and restart the application.
Definition: ScRecognitionContext.h:158
Image Description interface.
The provided image data is not supported by the recognition context.
Definition: ScRecognitionContext.h:70
No Scandit SDK license key was set. Please set a valid license key in your application.
Definition: ScRecognitionContext.h:110
void sc_recognition_context_retain(ScRecognitionContext *context)
Increase reference count of recognition context by one.