ScObjectTracker.h File Reference

Go to the source code of this file.

typedef struct
ScOpaqueObjectTracker 
ScObjectTracker
 
ScObjectTrackersc_object_tracker_new (ScRecognitionContext *context)
 
void sc_object_tracker_retain (ScObjectTracker *tracker)
 
void sc_object_tracker_release (ScObjectTracker *tracker)
 
ScBool sc_object_tracker_is_enabled (ScObjectTracker const *tracker)
 
void sc_object_tracker_set_enabled (ScObjectTracker *tracker, ScBool option)
 
ScObjectTrackerSessionsc_object_tracker_get_session (ScObjectTracker *tracker)
 
void sc_object_tracker_apply_scanner_settings (ScObjectTracker *tracker, ScBarcodeScannerSettings const *barcode_scanner_settings)
 

Detailed Description

API for tracking objects across frames.

Function Documentation

ScObjectTracker* sc_object_tracker_new ( ScRecognitionContext context)

Create a new object tracker.

Parameters
contextThe recognition context. Must not be null.
Returns
The new tracker object.
Since
7.0.0
Examples:
CommandLineMatrixScanCameraSample.c.
void sc_object_tracker_retain ( ScObjectTracker tracker)

Increase reference count of the object tracker.

Parameters
trackerReference 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
trackerReference to the tracker. May be null.
Since
5.8.0
Examples:
CommandLineMatrixScanCameraSample.c.
ScBool sc_object_tracker_is_enabled ( ScObjectTracker const *  tracker)

Check if tracking is enabled or disabled.

Parameters
trackerReference 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
optionTrue when tracking should be enabled, false if not
trackerReference to the tracker. Must not be null
Since
5.8.0
ScObjectTrackerSession* sc_object_tracker_get_session ( ScObjectTracker tracker)

Get the tracking session.

Parameters
trackerThe object tracker. Must not be null.
Returns
The session object. The session is owned by the object tracker and will be released automatically upon destruction of the tracker.
Since
7.0
Examples:
CommandLineMatrixScanCameraSample.c.
void sc_object_tracker_apply_scanner_settings ( ScObjectTracker tracker,
ScBarcodeScannerSettings const *  barcode_scanner_settings 
)

Configure the barcode scanner settings to be used with the object tracker.

Parameters
trackerThe object tracker. Must not be null.
barcode_scanner_settingsThe barcode scanner settings to apply. Must not be null.
Since
7.0
Examples:
CommandLineMatrixScanCameraSample.c.