Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Android

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 {
146 
148 
155 typedef struct {
157  uint32_t frame_id;
159 
167 SC_EXPORT const char *
169 
170 
171 #if SC_PLATFORM_ANDROID || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
172 
192 SC_EXPORT ScRecognitionContext *
193 sc_recognition_context_new(const char *license_key, const char* writable_data_path,
194  JNIEnv *env, jobject activity, const char* device_name);
195 #endif
196 
197 #if SC_PLATFORM_IOS || SC_GENERATE_DOCS
198 
215 SC_EXPORT ScRecognitionContext *
216 sc_recognition_context_new(const char *license_key, const char* device_name);
217 #endif
218 
219 #if SC_PLATFORM_GENERIC || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
220 
246 SC_EXPORT ScRecognitionContext *
247 sc_recognition_context_new(const char *license_key,
248  const char *writable_data_path,
249  const char *device_name);
250 #endif
251 
260 SC_EXPORT void sc_recognition_context_retain(ScRecognitionContext *context);
261 
273 
302 SC_EXPORT void
304 
337 SC_EXPORT ScProcessFrameResult
339  const ScImageDescription *image_description,
340  const uint8_t *image_data);
341 
353 SC_EXPORT void
355 
371 SC_EXPORT void
373  float latitude, float longitude);
374 
375 #if (SC_PLATFORM_IOS && defined(__OBJC__) && __OBJC__) || (defined(SC_GENERATE_DOCS) && SC_GENERATE_DOCS)
376 #include <UIKit/UIKit.h>
377 
397 SC_EXPORT ScContextStatusFlag
399  UIImage *image);
400 
401 #endif
402 
403 #if defined(__cplusplus)
404 }
405 #endif
406 
407 #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:155
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:156
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:157
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 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
The Scandit SDK license validation failed. Please insert 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.