Skip to content

Latest commit

 

History

History
1633 lines (1227 loc) · 69.4 KB

api-ode-trigger.md

File metadata and controls

1633 lines (1227 loc) · 69.4 KB

ODE Trigger API Reference

ODE Triggers use settable criteria to parse the frame and detected-object metadata looking for occurrences of specific "object detection events" (ODEs): Occurrence, Absence, Intersection, etc. Triggers, on ODE occurrence, iterate through their collection of ordered ODE Actions invoking each.

ODE Areas -- created from RGBA Polygons with up to eight (8) sides -- can be added to one or more Triggers as criteria for ODE occurrence as well.

Construction and Destruction

Triggers are created by calling one of the Type specific constructors defined below. Triggers are deleted by calling dsl_ode_trigger_delete, dsl_ode_trigger_delete_many, or dsl_ode_trigger_delete_all.

Adding and Removing Triggers

The relationship between ODE Pad Prop Handlers and ODE Triggers is one-to-many. A Trigger must be removed from a Handler before it can be used by another. Triggers are added to a handler by calling dsl_pph_ode_trigger_add and dsl_pph_ode_trigger_add_many, and removed with dsl_pph_ode_trigger_remove, dsl_pph_ode_trigger_remove_many, and dsl_pph_ode_trigger_remove_all.

Adding and Removing Actions

Multiple ODE Actions can be added to an ODE Trigger and the same ODE Action can be added to multiple Triggers. ODE Actions are added to an ODE Trigger by calling dsl_ode_trigger_action_add and dsl_ode_trigger_action_add_many, and removed with dsl_ode_trigger_action_remove, dsl_ode_trigger_action_remove_many, and dsl_ode_trigger_action_remove_all.

Adding and Removing Areas

As with Actions, multiple ODE areas can be added to an ODE Trigger and the same ODE Areas can be added to multiple Triggers. ODE Areas are added to an ODE Trigger by calling dsl_ode_trigger_area_add and dsl_ode_trigger_area_add_many and removed with dsl_ode_trigger_action_remove, dsl_ode_trigger_area_remove_many, and dsl_ode_trigger_area_remove_all.

Important Notes

  • Be careful when creating No-Limit ODE Triggers with Actions that save data to file as these operations can consume all available diskspace.
  • To use GIE Confidence as criteria, see the following NVIDIA page for the required DS 4.02 patch instructions to populate the confidence values in the object's meta data structure.

ODE Trigger API

Constructors:

Destructors:

Methods:

Return Values

The following return codes are used by the ODE Trigger API

#define DSL_RESULT_ODE_TRIGGER_NAME_NOT_UNIQUE                      0x000E0001
#define DSL_RESULT_ODE_TRIGGER_NAME_NOT_FOUND                       0x000E0002
#define DSL_RESULT_ODE_TRIGGER_THREW_EXCEPTION                      0x000E0003
#define DSL_RESULT_ODE_TRIGGER_IN_USE                               0x000E0004
#define DSL_RESULT_ODE_TRIGGER_SET_FAILED                           0x000E0005
#define DSL_RESULT_ODE_TRIGGER_IS_NOT_ODE_TRIGGER                   0x000E0006
#define DSL_RESULT_ODE_TRIGGER_ACTION_ADD_FAILED                    0x000E0007
#define DSL_RESULT_ODE_TRIGGER_ACTION_REMOVE_FAILED                 0x000E0008
#define DSL_RESULT_ODE_TRIGGER_ACTION_NOT_IN_USE                    0x000E0009
#define DSL_RESULT_ODE_TRIGGER_AREA_ADD_FAILED                      0x000E000A
#define DSL_RESULT_ODE_TRIGGER_AREA_REMOVE_FAILED                   0x000E000B
#define DSL_RESULT_ODE_TRIGGER_AREA_NOT_IN_USE                      0x000E000C
#define DSL_RESULT_ODE_TRIGGER_CLIENT_CALLBACK_INVALID              0x000E000D
#define DSL_RESULT_ODE_TRIGGER_ALWAYS_WHEN_PARAMETER_INVALID        0x000E000E
#define DSL_RESULT_ODE_TRIGGER_IS_NOT_AB_TYPE                       0x000E0010

Constants

The following symbolic constants are used by the ODE Trigger API

#define DSL_ODE_ANY_SOURCE                                          INT32_MAX
#define DSL_ODE_ANY_CLASS                                           INT32_MAX
#define DSL_ODE_TRIGGER_LIMIT_NONE                                  0
#define DSL_ODE_TRIGGER_LIMIT_ONE                                   1

/**
 * @brief Speicifes a set of defined points along a BBox border. 
 */
#define DSL_BBOX_POINT_CENTER                                       0
#define DSL_BBOX_POINT_NORTH_WEST                                   1
#define DSL_BBOX_POINT_NORTH                                        2
#define DSL_BBOX_POINT_NORTH_EAST                                   3
#define DSL_BBOX_POINT_EAST                                         4
#define DSL_BBOX_POINT_SOUTH_EAST                                   5
#define DSL_BBOX_POINT_SOUTH                                        6
#define DSL_BBOX_POINT_SOUTH_WEST                                   7
#define DSL_BBOX_POINT_WEST                                         8
#define DSL_BBOX_POINT_ANY                                          9

/**
 * @brief Methods of calculating distance between object BBoxes
 */
#define DSL_DISTANCE_METHOD_FIXED_PIXELS                            0
#define DSL_DISTANCE_METHOD_PERCENT_WIDTH_A                         1
#define DSL_DISTANCE_METHOD_PERCENT_WIDTH_B                         2
#define DSL_DISTANCE_METHOD_PERCENT_HEIGHT_A                        3
#define DSL_DISTANCE_METHOD_PERCENT_HEIGHT_B                        4

Callback Typedefs

dsl_ode_check_for_occurrence_cb

typedef boolean (*dsl_ode_check_for_occurrence_cb)(void* buffer,
    void* frame_meta, void* object_meta, void* client_data);

Defines a Callback typedef for a Custom ODE Trigger. Once registered, the function will be called on every object detected that meets the criteria for the Custom Trigger. The client, determining that custom criteria have been met, returns true signaling ODE occurrence. The Custom Trigger will then invoke all the client provided Actions.

Parameters

  • buffer - [in] pointer to frame buffer containing the Metadata for the object detected.
  • frame_meta - [in] opaque pointer to a frame_meta structure that triggered the ODE event.
  • object_meta - [in] opaque pointer to an object_meta structure that triggered the ODE event.
  • client_data - [in] opque point to client user data provided by the client on callback registration

Constructors

dsl_ode_trigger_always_new

DslReturnType dsl_ode_trigger_always_new(const wchar_t* name, const wchar_t* source, uint when);

The constructor creates an Always trigger that triggers an ODE occurrece on every new frame. Note, this is a No-Limit trigger, and setting a Class ID filer will have no effect. Although always triggered, the client selects when to Trigger an ODE occurrence for each frame; before (pre) or after (post) processing of all Object metadata by all other Triggers. As with all Triggers, Always Triggers can be enabled and disabled at anytime by calling dsl_ode_trigger_enabled_set

Always triggers are helpful for adding Display Types -- text, lines, rectangles, etc. -- to each frame for one or all sources.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable the filter.
  • when - [in] either DSL_PRE_CHECK_FOR_OCCURRENCES or DSL_POST_CHECK_FOR_OCCURRENCES.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this operation can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_always_new('my-always-trigger', DSL_ODE_ANY_SOURCE, DSL_PRE_CHECK_FOR_OCCURRENCES)

dsl_ode_trigger_absence_new

DslReturnType dsl_ode_trigger_absence_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

The constructor creates an Absence trigger that checks for the absence of Objects within a frame and generates an ODE occurrence if no objects occur.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this operation can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_absence_new('my-absence-trigger', DSL_ODE_ANY_SOURCE, 
    PGIE_PERSON_CLASS_ID, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_occurrence_new

DslReturnType dsl_ode_trigger_occurrence_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

The constructor creates an Occurrence trigger that checks for the occurrence of Objects within a frame and generates an ODE occurrence invoking all ODE Action for each object detected that passes the triggers (optional) criteria.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_occurrence_new('my-occurrence-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_instance_new

DslReturnType dsl_ode_trigger_instance_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

The constructor creates an Instance trigger that checks for new instances of Objects based on the object_id provided by the Object Tracker over consecutive frames. Each new object_id detected generates an ODE occurrence invoking all ODE Actions.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_instance_new('my-instance-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_persistence_new

DslReturnType dsl_ode_trigger_persistence_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit, uint minimum, uint maximum);

The constructor creates a Persistence trigger that checks for the persistence of Objects tracked -- based on the object_id provided by the Object Tracker over consecutive frames -- for a specified source and object class_id. Each object tracked for ">= minimum and/or <= maximum time will trigger an ODE occurrence.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.
  • minimum - [in] the minimum amount of time a unique object must remain detected before triggering an ODE occurrence - in units of seconds. 0 = no minimum.
  • maximum - [in] the maximum amount of time a unique object can remain detected before triggering an ODE occurrence - in units of seconds. 0 = no maximum.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_persistence_new('my-instance-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE, minimum=15, maximum=0)

dsl_ode_trigger_summation_new

DslReturnType dsl_ode_trigger_summation_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Summation trigger that counts the number Objects within a frame that pass the trigger's criteria. The Trigger generates an ODE occurrence invoking all ODE Actions once for per-frame until the Trigger limit is reached.

Note: Adding Actions to a Summation Trigger that require Object metadata during invocation - Object-Capture and Object-Fill as examples - will result in a non-action when invoked.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_summation_new('my-summation-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_accumulation_new

DslReturnType dsl_ode_trigger_accumulation_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Accumulation trigger that that checks for new instances of Objects that meet the Triggers criteria, while accumulating the number of occurrences over consecutive frames. New instance identification is based on Tracking Id, with the current accumulative occurrence value reported after each frame. The Trigger generates an ODE occurrence invoking all ODE Actions once for per-frame until the Trigger limit is reached.

Note: Adding Actions to an Accumulation Trigger that require Object metadata during invocation - Object-Capture and Object-Fill as examples - will result in a non-action when invoked.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_accumulation_new('my-accumulation-trigger', 'source-1, 
    PERSON_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_distance_new

DslReturnType dsl_ode_trigger_distance_new(const wchar_t* name, const wchar_t* source, 
    uint class_id_a, uint class_id_b, uint limit, uint minimum, uint maximum, 
    uint test_point, uint test_method);

This constructor creates a uniquely named Distance Trigger that determines if Objects, that meet the Trigger's criteria, are less than a minimum and/or greater than a maximum distance from one another. If detected, the Trigger will generate an ODE occurrence invoking all ODE Actions twice, once for each object in the pair. Object detection is based on the specification of two Class IDs; A and B. All Objects of Class A will be tested against all Objects of Class B. class_id_a and class_id_b can both be set to the same Class Id and DSL_ODE_ANY_CLASS. The points and method of distance measurement (fixed or ratio) are defined as well.

Intersection requires at least one pixel of overlap between a pair of object's rectangles.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id_a - [in] inference class id filter A. Use DSL_ODE_ANY_CLASS to disable the filter.
  • class_id_b - [in] inference class id filter B. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.
  • minimum - [in] the minimum distance between objects in either pixels or percentage of BBox edge as specified by the test_method parameter below.
  • maximum - [in] the maximum distance between objects in either pixels or percentage of BBox edge as specified by the test_method parameter below.
  • test_point - [in] the point on the bounding box rectangle to use for measurement, one of DSL_BBOX_POINT.
  • test_method - [in] method of measuring the distance between objects, one of DSL_DISTANCE_METHOD.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_distance_new('my-distance-trigger', 
    source = DSL_ODE_ANY_SOURCE, 
    class_id_a = PGIE_CLASS_ID_PERSON, 
    class_id_b = PGIE_CLASS_ID_VEHICLE,
    minimum = 300,
    maximum = 0,
    test_point = DSL_BBOX_POINT_SOUTH,
    test_method = DSL_DISTANCE_METHOD_PERCENT_WIDTH_A)

dsl_ode_trigger_intersection_new

DslReturnType dsl_ode_trigger_intersection_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Intersection Trigger that determines if Objects that meet the Trigger's criteria intersect, and generates an ODE occurrence invoking all ODE Actions twice, once for each object in the intersection pair. Object detection is based on the specification of two Class IDs; A and B. All Objects of Class A will be tested against all Objects of Class B. class_id_a and class_id_b can both be set to the same Class Id and DSL_ODE_ANY_CLASS.

For example: Given three objects A, B, and C. If A intersects B and B intersects C, then two unique ODE occurrences are generated. Each Action owned by the Trigger will be called for each object for every overlapping pair, i.e. a total of four times in this example. If each of the three objects intersect with the other two, then three ODE occurrences will be triggered with each action called a total of 6 times.

Intersection requires at least one pixel of overlap between a pair of object's rectangles.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id_a - [in] inference class id filter A. Use DSL_ODE_ANY_CLASS to disable the filter.
  • class_id_b - [in] inference class id filter B. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_intersection_new('my-intersection-trigger', 
    source = DSL_ODE_ANY_SOURCE, 
    class_id_a = PGIE_CLASS_ID_PERSON, 
    class_id_b = PGIE_CLASS_ID_VEHICLE,
    limit = DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_count_new

DslReturnType dsl_ode_trigger_range_new(const wchar_t* name, const wchar_t* source, 
    uint class_id, uint limit, uint lower, uint upper);

This constructor creates a uniquely named Count Trigger that checks for the occurrence of Objects within a frame that meet the Trigger's criteria against a range of numbers. The Trigger generates an ODE occurrence invoking all Actions if the object count is below and/or above a minimum and maximum count.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.
  • minimum - [in] the minimum count for triggering ODE occurrence, 0 = no minimum.
  • maximum - [in] the maximum count for triggering ODE occurrence, 0 = no maximum.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_count_new('my-count-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE, minimum, maximum)

dsl_ode_trigger_new_high_new

DslReturnType dsl_ode_trigger_new_high_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit, uint preset);

This constructor creates a uniquely named New High Trigger that checks for the occurrence of Objects within a frame that meet the Trigger's criteria and deterines if the numbers has reached a new high. The Trigger generates an ODE occurrence invoking all Actions if the object count is above the highest count. The Trigger can be created with a preset high value of 0 or greater.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.
  • preset - [in] initial high count to start with. High count will be reset to the preset on trigger reset.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_new_high_new('my-new-high-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE, preset=0)

dsl_ode_trigger_new_low_new

DslReturnType dsl_ode_trigger_new_low_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit, uint preset);

This constructor creates a uniquely named New Low Trigger that checks for the occurrence of Objects within a frame that meets the Trigger's criteria and deterines if the number has reached a new low. The Trigger generates an ODE occurrence invoking all Actions if the object count is above the lowest count. The Trigger can be created with a preset low value of 0 or greater.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.
  • preset - [in] initial low count to start with. Low count will be reset to the preset on trigger reset.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_new_low_new('my-new-low-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE, preset=4)

dsl_ode_trigger_smallest_new

DslReturnType dsl_ode_trigger_smallest_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named smallest trigger that checks for the occurrence of Objects within a frame, and if at least one is found, Triggers on the Object with smallest rectangle area.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_smallest_new('my-smallest-trigger', 
    DSL_ODE_ANY_SOURCE, DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_largest_new

DslReturnType dsl_ode_trigger_largest_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Largest trigger that checks for the occurrence of Objects within a frame, and if at least one is found, Triggers on the Object with largest rectangle area.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_largest_new('my-largest-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_earliest_new

DslReturnType dsl_ode_trigger_earliest_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Earliest Trigger that checks for the persistence of Objects tracked and will trigger on the Object with the greatest time of persistence (earliest) if at least one is found..

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_earliest_new('my-earliest-trigger', 
    DSL_ODE_ANY_SOURCE, DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_latest_new

DslReturnType dsl_ode_trigger_latest_new(const wchar_t* name, 
    const wchar_t* source, uint class_id, uint limit);

This constructor creates a uniquely named Latest Trigger that checks for the persistence of Objects tracked and will trigger on the Object with the least time of persistence (latest) if at least one is found.

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_latest_new('my-latest-trigger', DSL_ODE_ANY_SOURCE, 
    DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE)

dsl_ode_trigger_custom_new

DslReturnType dsl_ode_trigger_custom_new(const wchar_t* name, const wchar_t* source, 
    uint class_id, uint limit, dsl_ode_check_for_occurrence_cb client_checker, void* client_data);

The constructor creates a Uniquely named Custom Trigger that checks for the occurrence of Objects within a frame that meets the Triggers criteria and calls a Callback function that allows the client to customize the Trigger. The Callback function is called with the buffer

Parameters

  • name - [in] unique name for the ODE Trigger to create.
  • source - [in] unique name of the Source to filter on. Use NULL or DSL_ODE_ANY_SOURCE (defined as NULL) to disable filer.
  • class_id - [in] inference class id filter. Use DSL_ODE_ANY_CLASS to disable the filter.
  • limit - [in] the Trigger limit. Once met, the Trigger will stop triggering new ODE occurrences. Set to DSL_ODE_TRIGGER_LIMIT_NONE (0) for no limit.

Note Be careful when creating No-Limit ODE Triggers with Actions that save data to file as this can consume all available diskspace.

Returns

  • DSL_RESULT_SUCCESS on successful creation. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_custom_new('my-custom-trigger', 
        DSL_ODE_ANY_CLASS, DSL_ODE_TRIGGER_LIMIT_NONE, my_check_for_occurrence_cb, my_client_data)

Destructors

dsl_ode_trigger_delete

DslReturnType dsl_ode_trigger_delete(const wchar_t* trigger);

This destructor deletes a single, uniquely named ODE Trigger. The destructor will fail if the Trigger is currently in-use by an ODE Handler

Parameters

  • trigger - [in] unique name for the ODE Trigger to delete.

Returns

  • DSL_RESULT_SUCCESS on successful deletion. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_delete('my-trigger')

dsl_ode_trigger_delete_many

DslReturnType dsl_trigger_delete_many(const wchar_t** triggers);

This destructor deletes multiple uniquely named ODE Triggers. Each name is checked for existence, with the function returning on first failure. The destructor will fail if one of the Actions is currently in-use by one or more ODE Triggers

Parameters

  • trigger - [in] a NULL terminated array of uniquely named ODE Triggers to delete.

Returns

  • DSL_RESULT_SUCCESS on successful deletion. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_delete_many(['my-trigger-a', 'my-trigger-b', 'my-trigger-c', None])

dsl_ode_trigger_delete_all

DslReturnType dsl_ode_trigger_delete_all();

This destructor deletes all ODE Triggers currently in memory. The destructor will fail if any one of the Triggers is currently in-use by an ODE Handler.

Returns

  • DSL_RESULT_SUCCESS on successful deletion. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_delete_all()

Methods

dsl_ode_trigger_count_range_get

DslReturnType dsl_ode_trigger_count_range_get(const wchar_t* name, 
    uint* minimum, uint* maximum);

This service gets the current minimum and maximum count settings in use by the named ODE Count Trigger.

Parameters

  • name - [in] unique name of the ODE Count Trigger to query.
  • minimum - [in] the current minimum count for triggering ODE occurrence, 0 = no minimum.
  • maximum - [in] the current minimum count for triggering ODE occurrence, 0 = no maximum.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, minimum, maximum = dsl_ode_trigger_count_range_get('my-trigger')

dsl_ode_trigger_count_range_set

DslReturnType dsl_ode_trigger_count_range_set(const wchar_t* name, 
    uint minimum, uint maximum);

This service sets the current minimum and maximum count settings to use for the named ODE Count Trigger.

Parameters

  • name - [in] unique name of the ODE Count Trigger to update.
  • minimum - [in] the new minimum count for triggering ODE occurrence, 0 = no minimum.
  • maximum - [in] the new maximum count for triggering ODE occurrence, 0 = no maximum.

Returns

  • DSL_RESULT_SUCCESS on successful update. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_count_range_set('my-trigger', 10, 0)

dsl_ode_trigger_distance_range_get

DslReturnType dsl_ode_trigger_distance_range_get(const wchar_t* name, 
    uint* minimum, uint* maximum);

This service gets the current minimum and maximum distance settings in use by the named ODE Distance Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • minimum - [out] the current minimum distance between objects in either pixels or percentage of BBox point as specified by the test_method parameter below.
  • maximum - [out] the current maximum distance between objects in either pixels or percentage of BBox point as specified by the test_method parameter below.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, minimum, maximum = dsl_ode_trigger_distance_range_get('my-trigger')

dsl_ode_trigger_distance_range_set

DslReturnType dsl_ode_trigger_distance_range_set(const wchar_t* name, 
    uint minimum, uint maximum);

This service sets the current minimum and maximum distance settings to use for the named ODE Distance Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • minimum - [in] the distance between objects in either pixels or percentage of BBox point as specified by the test_method parameter below.
  • maximum - [in] the maximum distance between objects in either pixels or percentage of BBox point as specified by the test_method parameter below.

Returns

  • DSL_RESULT_SUCCESS on successful update. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_distance_range_set('my-trigger', 100, 300)

dsl_ode_trigger_distance_test_params_get

DslReturnType dsl_ode_trigger_distance_test_params_get(const wchar_t* name, 
    uint* test_point, uint* test_method);

This service gets the current Test Point and Test Method parameters for the named ODE Distance Trigger

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • test_point - [out] the point on the bounding box rectangle to use for measurement, one of DSL_BBOX_POINT
  • test_method - [out] method of measuring the distance between objects, one of DSL_DISTANCE_METHOD

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, test_point, test_method = dsl_ode_trigger_distance_test_params_get('my-trigger')

dsl_ode_trigger_distance_test_params_set

DslReturnType dsl_ode_trigger_distance_test_params_set(const wchar_t* name, 
    uint test_point, uint test_method);

This service sets the current Test Point and Test Method parameters for the named ODE Distance Trigger to use.

Parameters

  • name - [in] unique name of the ODE Distance Trigger to update.
  • test_point - [in] the point on the bounding box rectangle to use for measurement, one of DSL_BBOX_POINT
  • test_method - [in] method of measuring the distance between objects, one of DSL_DISTANCE_METHOD

Returns

  • DSL_RESULT_SUCCESS on successful update. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_distance_test_params_get('my-trigger', 
    test_point = DSL_BBOX_POINT_SOUTH,
    test_method = DSL_DISTANCE_METHOD_PERCENT_WIDTH_A)

dsl_ode_trigger_persistence_range_get

DslReturnType dsl_ode_trigger_persistence_range_get(const wchar_t* name, 
    uint* minimum, uint* maximum);

This service gets the current minimum and maximum time settings in use by the named ODE Persistence Trigger.

Parameters

  • name - [in] unique name of the ODE Count Trigger to query.
  • minimum - [in] the minimum amount of time a unique object must remain detected before triggering an ODE occurrence - in units of seconds. 0 = no minimum
  • maximum - [in] the maximum amount of time a unique object can remain detected before triggering an ODE occurrence - in units of seconds. 0 = no maximum

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, minimum, maximum = dsl_ode_trigger_persistence_range_get('my-trigger')

dsl_ode_trigger_persistence_range_set

DslReturnType dsl_ode_trigger_persistence_range_set(const wchar_t* name, 
    uint minimum, uint maximum);

This service sets the current minimum and maximum time settings to use for the named ODE Persistence Trigger.

Parameters

  • name - [in] unique name of the ODE Count Trigger to update.
  • minimum - [in] the minimum amount of time a unique object must remain detected before triggering an ODE occurrence - in units of seconds. 0 = no minimum
  • maximum - [in] the maximum amount of time a unique object can remain detected before triggering an ODE occurrence - in units of seconds. 0 = no maximum

Returns

  • DSL_RESULT_SUCCESS on successful update. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_persistence_range_set('my-trigger', 100, 300)

dsl_ode_trigger_reset

DslReturnType dsl_ode_trigger_reset(const wchar_t* name);

This service resets a named ODE Trigger, setting its triggered count to 0. This affects Triggers with fixed limits, whether they have reached their limit or not.

Parameters

  • name - [in] unique name of the ODE Trigger to reset.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_reset('my-trigger')

dsl_ode_trigger_reset_timeout_get

DslReturnType dsl_ode_trigger_reset_timeout_get(const wchar_t* name, uint *timeout);

This service gets the current auto-reset timeout setting for the named ODE Trigger. If set, upon reaching its limit, the Trigger will start a timer to auto-reset on expiration. A timeout of 0 disables auto-reset -- default setting for all triggers.

Parameters

  • name - [in] unique name of the ODE Trigger to reset.
  • timeout - [out] current timeout value in units of seconds.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, timeout = dsl_ode_trigger_reset_timeout_get('my-trigger')

dsl_ode_trigger_reset_timeout_set

DslReturnType dsl_ode_trigger_reset_timeout_set(const wchar_t* name, uint timeout);

This service sets the current auto-reset timeout setting for the named ODE Trigger. If set, upon reaching its limit, the Trigger will start a timer to auto-reset on expiration. A timeout of 0 disables auto-reset, the default setting for all triggers.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • timeout - [in] new timeout value in units of seconds.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_reset_timeout_set('my-trigger', 3)

dsl_ode_trigger_enabled_get

DslReturnType dsl_ode_trigger_enabled_get(const wchar_t* name, boolean* enabled);

This service returns the current enabled setting for the named ODE Trigger. Triggers are enabled by default during construction.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • enabled - [out] true if the ODE Trigger is currently enabled, false otherwise.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, enabled = dsl_ode_trigger_enabled_get('my-trigger')

dsl_ode_trigger_enabled_set

DslReturnType dsl_ode_trigger_enabled_set(const wchar_t* name, boolean enabled);

This service sets the enabled setting for the named ODE Trigger. Triggers are enabled by default during construction.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • enabled - [in] set to true to enable the ODE Trigger, false otherwise.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_enabled_set('my-trigger', False)

dsl_ode_trigger_source_get

DslReturnType dsl_ode_trigger_source_get(const wchar_t* name, const wchar_t** source);

This service returns the current source_id filter setting for the named ODE Trigger. A value of DSL_ODE_ANY_SOURCE (defined as NULL) indicates that the filter is disable and Source name will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • source - [out] current source name filter for the ODE Trigger to filter on.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, source_name = dsl_ode_trigger_source_get('my-trigger')

dsl_ode_trigger_source_set

DslReturnType dsl_ode_trigger_source_set(const wchar_t* name, const wchar_t* source);

This service sets the current source filter setting for the named ODE Trigger. A value of DSL_ODE_ANY_SOURCE (or NULL) disables the filter and the Source name will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • source - [in] new Source name for the ODE Trigger to filter on, or DSL_ODE_ANY_SOURCE to disable.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_source_id_set('my-trigger', 'my-source-1')

dsl_ode_trigger_class_id_get

DslReturnType dsl_ode_trigger_class_id_get(const wchar_t* name, uint* class_id);

This service returns the current class_id filter setting for the named ODE Trigger. A value of DSL_ODE_ANY_CLASS indicates that the filter is disable and the GIE class Id will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • class_id - [out] current class Id filter for the ODE Trigger to filter on.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, class_id = dsl_ode_trigger_class_id_get('my-trigger')

dsl_ode_trigger_class_id_set

DslReturnType dsl_ode_trigger_class_id_set(const wchar_t* name, uint class_id);

This service sets the current class_id filter setting for the named ODE Trigger. A value of DSL_ODE_ANY_CLASS disables the filter and the GIE class Id will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • class_id - [in] new class Id filter for the ODE Trigger to filter on, or DSL_ODE_ANY_CLASS to disable.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_class_id_set('my-trigger', DSL_ODE_ANY_CLASS)

dsl_ode_trigger_class_id_ab_get

DslReturnType dsl_ode_trigger_class_id_ab_get(const wchar_t* name, 
    uint* class_id_a, uint* class_id_b);

This service returns the current class_id_a and class_id_b filter settings for the named AB Type ODE Trigger. A value of DSL_ODE_ANY_CLASS indicates that the class filter is disabled.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • class_id_a - [out] current class Id A filter for the ODE Trigger to filter on.
  • class_id_a - [out] current class Id B filter for the ODE Trigger to filter on.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval, class_id_a, class_id_b = dsl_ode_trigger_class_id_ab_get('my-trigger')

dsl_ode_trigger_class_id_ab_set

DslReturnType dsl_ode_trigger_class_id_ab_set(const wchar_t* name, 
    uint class_id_a, uint class_id_b);;

This service sets the currentclass_id_a and class_id_b filter settings for a named AB Type ODE Trigger. Both can be set to the same Class Id or DSL_ODE_ANY_CLASS

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • class_id_a - [in] new class Id A filter for the ODE Trigger to filter on.
  • class_id_b - [in] new class Id B filter for the ODE Trigger to filter on.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_class_id_ab_set('my-trigger', 
    class_id_a = DSL_ODE_ANY_CLASS, class_id_b = DSL_ODE_ANY_CLASS)

dsl_ode_trigger_limit_get

DslReturnType dsl_ode_trigger_limit_get(const wchar_t* name, uint* limit);

This service returns the current Trigger limit setting for the named ODE Trigger. A value of zero indicates NO Limit

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • limit - [out] current limit setting for the ODE Trigger.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure..

Python Example

retval, limit = dsl_ode_trigger_limit_get('my-trigger')

dsl_ode_trigger_limit_set

DslReturnType dsl_ode_trigger_limit_set(const wchar_t* name, uint limit);

This service sets the current limit setting for the named ODE Trigger. Setting the limit to zert disables the limit check, i.e. no limit.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • limit - [in] new limit for the ODE Trigger to filter on, 0 to indicate no limit.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_limit_set('my-trigger', 0)

dsl_ode_trigger_confidence_min_get

DslReturnType dsl_ode_trigger_confidence_min_get(const wchar_t* name, double* min_confidence);

This service returns the current minimum confidence criteria for the named ODE Trigger. A value of 0 (default) indicates that the criteria is disable and the detected object's GIE confidence value will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • min_confidence - [out] current minimum confidence value between 0.0 and 1.0 for the ODE Trigger to filter on, 0 indicates disable.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, min_confidence = dsl_ode_trigger_confidence_min_get('my-trigger')

dsl_ode_trigger_confidence_min_set

DslReturnType dsl_ode_trigger_confidence_min_set(const wchar_t* name, double min_confidence);

This service sets the minimum confidence criteria for the named ODE Trigger. A value of 0 disables the filter and the GIE confidence level will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • min_confidence - [in] new minimum confidence value as criteria for the ODE Trigger to filter on, or 0 to disable.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_confidence_min_set('my-trigger', min_confidence)

dsl_ode_trigger_dimensions_min_get

DslReturnType dsl_ode_trigger_dimensions_min_get(const wchar_t* name, uint* min_width, uint* min_height);

This service returns the current minimum dimensions for the named ODE Trigger. A value of 0 (default) indicates that the Object's rectangle width and/or height will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • min_width - [out] current minimum width value for the ODE Trigger to filter on, 0 indicates disabled.
  • min_hight - [out] current minimum height value for the ODE Trigger to filter on, 0 indicates disabled.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, min_width, min_height = dsl_ode_trigger_dimensions_min_get('my-trigger')

dsl_ode_trigger_dimensions_min_set

DslReturnType dsl_ode_trigger_dimensions_min_set(const wchar_t* name, uint min_width, uint min_height);

This service sets the current minimum dimensions for the named ODE Trigger. A value of 0 (default) indicates that the Object's rectangle width and/or height will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • min_width - [out] minimum width value for the ODE Trigger to filter on, 0 indicates disabled.
  • min_hight - [out] minimum height value for the ODE Trigger to filter on, 0 indicates disabled.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_dimensions_min_get('my-trigger', min_width, min_height)

dsl_ode_trigger_dimensions_max_get

DslReturnType dsl_ode_trigger_dimensions_max_get(const wchar_t* name, uint* max_width, uint* max_height);

This service returns the current maximum dimensions for the named ODE Trigger. A value of 0 (default) indicates that the Object's rectangle width and/or height will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • max_width - [out] current maximum width value for the ODE Trigger to filter on, 0 indicates disabled.
  • max_hight - [out] current maximum height value for the ODE Trigger to filter on, 0 indicates disabled.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, max_width, max_height = dsl_ode_trigger_dimensions_max_get('my-trigger')

dsl_ode_trigger_dimensions_max_set

DslReturnType dsl_ode_trigger_dimensions_max_set(const wchar_t* name, uint max_width, uint max_height);

This service sets the current maximum dimensions for the named ODE Trigger. A value of 0 (default) indicates that the Object's rectangle width and/or height will not be used as criteria for ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • max_width - [out] maximum width value for the ODE Trigger to filter on, 0 indicates disabled.
  • max_hight - [out] maximum height value for the ODE Trigger to filter on, 0 indicates disabled.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_dimensions_max_get('my-trigger', max_width, max_height)

dsl_ode_trigger_infer_done_only_get

DslReturnType dsl_ode_trigger_infer_done_only_get(const wchar_t* name, boolean* infer_done_only)

This service returns the current "infer-done-only" criteria for the named ODE Trigger. A value of False (default) indicates that the Object's "infer-done" meta flag will not be used as criteria for ODE occurrence. If set to True, only those frames with the "infer-done" flag = true can trigger an ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • infer_done_only - [out] if set to true, then the "inference-done" filer is enable, false indicates disabled.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, infer_done_only = dsl_ode_trigger_infer_done_only_get('my-trigger')

dsl_ode_trigger_infer_done_only_set

DslReturnType dsl_ode_trigger_infer_done_only_get(const wchar_t* name, boolean* infer_done_only)

This service sets the "inference-done-only" criteria for the named ODE Trigger. A value of False (default) indicates that the Object's "inference-done" flag will not be used as criteria for ODE occurrence. If set to True, only those frames with the "inference-done" flag = true can trigger an ODE occurrence.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • infer_done_only - [in] set to true ot enable the "infer-done-only" criteria, false (default) to disable.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_infer_done_only_get('my-trigger', True)

dsl_ode_trigger_interval_get

DslReturnType dsl_ode_trigger_interval_get(const wchar_t* name, uint* interval);

This service gets the current frame processing interval setting for the named ODE Trigger, If set to n, the Trigger will only process every nth frame while skipping the others.

Parameters

  • name - [in] unique name of the ODE Trigger to query.
  • limit - [out] current interval setting for the ODE Trigger. Default = 0.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure.

Python Example

retval, interval = dsl_ode_trigger_interval_get('my-trigger')

dsl_ode_trigger_interval_set

DslReturnType dsl_ode_trigger_interval_set(const wchar_t* name, uint interval);

This service sets the current frame processing interval setting for the named ODE Trigger, If set to n, the Trigger will only process every nth frame while skipping the others.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • interval - [in] new interval for the ODE Trigger to process frames on. Set to 0 (default) or 1 to process all frames.

Returns

  • DSL_RESULT_SUCCESS on successful query. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_interval_set('my-trigger', 5)

dsl_ode_trigger_action_add

DslReturnType dsl_ode_trigger_action_add(const wchar_t* name, const wchar_t* action);

This service adds a named ODE Action to a named ODE Trigger. The same Action can be added to multiple Triggers.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • action - [in] unique name of the ODE Action to add.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_action_add('my-trigger', 'my-action')

dsl_ode_trigger_action_add_many

DslReturnType dsl_ode_trigger_action_add_many(const wchar_t* name, const wchar_t** actions);

This service adds a Null terminated list of named ODE Actions to a named ODE Trigger. The same Actions can be added to multiple Triggers.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • actions - [in] a Null terminated list of unique names of the ODE Actions to add.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_action_add_many('my-trigger', ['my-action-a', 'my-action-b', 'my-action-c', None])

dsl_ode_trigger_action_remove

DslReturnType dsl_ode_trigger_action_remove(const wchar_t* name, const wchar_t* action);

This service removes a named ODE Action from a named ODE Trigger. The services will fail if the Action is not currently in-use by the named Trigger

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • action - [in] unique name of the ODE Action to remove

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_action_remove('my-trigger', 'my-action')

dsl_ode_trigger_action_remove_many

DslReturnType dsl_ode_trigger_action_remove_many(const wchar_t* name, const wchar_t** actions);

This service removes a Null terminated list of named ODE Actions to a named ODE Trigger. The service will fail if any of the named Actions are not currently in-use by the named Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • actions - [in] a Null terminated list of unique names of the ODE Actions to remove.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_action_remove_many('my-trigger', ['my-action-a', 'my-action-b', 'my-action-c', None])

dsl_ode_trigger_action_remove_all

DslReturnType dsl_ode_trigger_action_remove_all(const wchar_t* name);

This service removes all ODE Actions from a named ODE Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to update.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_action_remove_all('my-trigger')

dsl_ode_trigger_area_add

DslReturnType dsl_ode_trigger_area_add(const wchar_t* name, const wchar_t* action);

This service adds a named ODE Area to a named ODE Trigger. The same Area can be added to multiple Triggers.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • area - [in] unique name of the ODE Area to add

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_area_add('my-trigger', 'my-area')

dsl_ode_trigger_area_add_many

DslReturnType dsl_ode_trigger_area_add_many(const wchar_t* name, const wchar_t** areas);

This service adds a Null terminated list of named ODE Areas to a named ODE Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • areas - [in] a Null terminated list of unique names of the ODE Areas to add.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_area_add_many('my-trigger', ['my-area-a', 'my-area-b', 'my-area-c', None])

dsl_ode_trigger_area_remove

DslReturnType dsl_ode_trigger_area_remove(const wchar_t* name, const wchar_t* area);

This service removes a named ODE Area from a named ODE Trigger. The services will fail if the Area is not currently in-use by the named Trigger

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • area - [in] unique name of the ODE Area to remove

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure

Python Example

retval = dsl_ode_trigger_area_remove('my-trigger', 'my-area')

dsl_ode_trigger_area_remove_many

DslReturnType dsl_ode_trigger_area_remove_many(const wchar_t* name, const wchar_t** areas);

This service removes a Null terminated list of named ODE Areas to a named ODE Trigger. The service will fail if one of the named Areas is not currently in-use by the named Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to update.
  • areas - [in] a Null terminated list of unique names of the ODE Areas to remove.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_area_remove_many('my-trigger', ['my-area-a', 'my-area-b', 'my-area-c', None])

dsl_ode_trigger_area_remove_all

DslReturnType dsl_ode_trigger_area_remove_all(const wchar_t* name);

This service removes all ODE Areas from a named ODE Trigger.

Parameters

  • name - [in] unique name of the ODE Trigger to update.

Returns

  • DSL_RESULT_SUCCESS on successful add. One of the Return Values defined above on failure.

Python Example

retval = dsl_ode_trigger_area_remove_all('my-trigger')

dsl_ode_trigger_list_size

uint dsl_ode_trigger_list_size();

This service returns the size of the ODE Trigger container, i.e. the number of Triggers currently in memory.

Returns

  • The size of the ODE Trigger container.

Python Example

size = dsl_ode_trigger_list_size()

API Reference