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/ScCommon.h>
14 
15 #if SC_PLATFORM_ANDROID
16 #include <jni.h>
17 #endif
18 
19 #include <Scandit/ScConfig.h>
21 
22 #if defined(__cplusplus)
23 extern "C" {
24 #endif
25 
41 typedef struct ScOpaqueRecognitionContext ScRecognitionContext;
44 
50 typedef enum {
152 
154 
161 typedef struct {
163  uint32_t frame_id;
165 
173 SC_EXPORT const char *
175 
176 
177 #if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
178 
198 SC_EXPORT ScRecognitionContext *
199 sc_recognition_context_new(const char *license_key, const char* writable_data_path,
200  JNIEnv *env, jobject activity, const char* device_name);
201 #endif
202 
203 #if SC_PLATFORM_IOS || SC_GENERATE_DOCS
204 
221 SC_EXPORT ScRecognitionContext *
222 sc_recognition_context_new(const char *license_key, const char* device_name);
223 #endif
224 
225 #if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
226 
252 SC_EXPORT ScRecognitionContext *
253 sc_recognition_context_new(const char *license_key,
254  const char *writable_data_path,
255  const char *device_name);
256 #endif
257 
266 SC_EXPORT void sc_recognition_context_retain(ScRecognitionContext *context);
267 
279 
308 SC_EXPORT void
310 
343 SC_EXPORT ScProcessFrameResult
345  const ScImageDescription *image_description,
346  const uint8_t *image_data);
347 
359 SC_EXPORT void
361 
377 SC_EXPORT void
379  float latitude, float longitude);
380 
381 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
382 #include <UIKit/UIKit.h>
383 
403 SC_EXPORT ScContextStatusFlag
405  UIImage *image);
406 
407 #endif
408 
409 #if defined(__cplusplus)
410 }
411 #endif
412 
413 #endif // SC_RECOGNITION_CONTEXT_H_
Opaque recognition context data structure.
The context is status is OK.
Definition: ScRecognitionContext.h:58
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:116
Result status and frame id.
Definition: ScRecognitionContext.h:161
The provided image data is missing properties.
Definition: ScRecognitionContext.h:75
ScContextStatusFlag
Context status of a frame.
Definition: ScRecognitionContext.h:50
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:162
The context status is unknown.
Definition: ScRecognitionContext.h:54
The Scandit SDK license file can not be found or accessed.
Definition: ScRecognitionContext.h:93
Scandit SDK failed to get network access which is mandatory for the test edition of the Scandit Barco...
Definition: ScRecognitionContext.h:81
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.
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:138
The Scandit SDK validation failed. Your app ID does not match the license key's app ID...
Definition: ScRecognitionContext.h:131
The Scandit SDK license validation failed. Your license key does not include this platform...
Definition: ScRecognitionContext.h:123
Scandit SDK validation failed. Check your license key and network connection.
Definition: ScRecognitionContext.h:97
Scandit SDK detected a corrupted log and could not validate this installation.
Definition: ScRecognitionContext.h:101
Scandit SDK validation failed. Make sure your app key is valid and check your account for available d...
Definition: ScRecognitionContext.h:105
The Scandit SDK validation failed. Your license key does not include support for this SDK version...
Definition: ScRecognitionContext.h:145
uint32_t frame_id
frame identification number within the current frame sequence
Definition: ScRecognitionContext.h:163
The context encountered an internal error.
Definition: ScRecognitionContext.h:62
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:151
The Scandit SDK license file expired. Please obtain a new one.
Definition: ScRecognitionContext.h:87
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:109
void sc_recognition_context_retain(ScRecognitionContext *context)
Increase reference count of recognition context by one.