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
Go to the source code of this file.
Data Structures | |
| struct | ScObjectTrackerCallbacks |
| typedef struct ScOpaqueObjectTracker | ScObjectTracker |
| typedef void(* | ScObjectTrackerEventFunc) (const ScTrackedObject *object, void *user_data) |
| typedef void(* | ScObjectTrackerEventFuncLost) (ScTrackedObjectType type, uint32_t tracking_id, void *user_data) |
| typedef void(* | ScObjectTrackerEventFuncPredicted) (uint32_t tracking_id, ScQuadrilateral quadrilateral, float dt, void *user_data) |
| ScObjectTracker * | sc_object_tracker_new (ScRecognitionContext *context, ScObjectTrackerCallbacks *callbacks, void *callback_user_data) |
| void | sc_object_tracker_retain (ScObjectTracker *tracker) |
| void | sc_object_tracker_release (ScObjectTracker *tracker) |
| ScBool | sc_object_tracker_is_enabled (const ScObjectTracker *tracker) |
| void | sc_object_tracker_set_enabled (ScObjectTracker *tracker, ScBool option) |
Detailed Description
API for tracking objects across frames.
- Copyright
- Copyright (c) 2016 Scandit AG. All rights reserved.
Data Structure Documentation
| struct ScObjectTrackerCallbacks |
Callback storage structure. Set a callback to NULL to ignore it.
- Examples:
- CommandLineMatrixScanCameraSample.c.
| Data Fields | ||
|---|---|---|
| ScObjectTrackerEventFunc | on_object_appeared | |
| ScObjectTrackerEventFunc | on_object_updated | |
| ScObjectTrackerEventFuncLost | on_object_lost | |
| ScObjectTrackerEventFuncPredicted | on_object_predicted | |
Function Documentation
| ScObjectTracker* sc_object_tracker_new | ( | ScRecognitionContext * | context, |
| ScObjectTrackerCallbacks * | callbacks, | ||
| void * | callback_user_data | ||
| ) |
Create a new object tracker.
- Parameters
-
context The recognition context. Must not be null. callbacks Set of callbacks to be invoked when a new objects are found, their position is updated, or they are lost. Must not be null, however, each of the callbacks may be null, if the user is not interested in receiving these events. callback_user_data Optional pointer to user data which will be passed to the event functions as the second argument.
- Returns
- The new tracker object.
- Since
- 5.8.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
| void sc_object_tracker_retain | ( | ScObjectTracker * | tracker | ) |
Increase reference count of the object tracker.
- Parameters
-
tracker Reference to the tracker. Must not be null
- Since
- 5.8.0
| void sc_object_tracker_release | ( | ScObjectTracker * | tracker | ) |
Decrease reference count of tracker object.
- Parameters
-
tracker Reference to the tracker. May be null.
- Since
- 5.8.0
- Examples:
- CommandLineMatrixScanCameraSample.c.
| ScBool sc_object_tracker_is_enabled | ( | const ScObjectTracker * | tracker | ) |
Check if tracking is enabled or disabled.
- Parameters
-
tracker Reference to the tracker. Must not be null
- Returns
- True when tracking is enabled, false if not
- Since
- 5.8.0
| void sc_object_tracker_set_enabled | ( | ScObjectTracker * | tracker, |
| ScBool | option | ||
| ) |
Enable or disable tracking.
- Parameters
-
option True when tracking should be enabled, false if not tracker Reference to the tracker. Must not be null
- Since
- 5.8.0