IVIDANALYTICS_OutArgs Struct Reference

Defines the run time output arguments for all IVIDANALYTICS instance objects. More...

#include <ividanalytics.h>

Collaboration diagram for IVIDANALYTICS_OutArgs:

Data Fields
XDAS_Int32	size
XDAS_Int32	numTargets
XDM_Rect	targets [128]
XDAS_Int32	numEvents
XDAS_Int32	eventId [128]
XDAS_Int32	extendedError
	Extended error information.
XDM_Date	date

---

Detailed Description

Defines the run time output arguments for all IVIDANALYTICS instance objects.

@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters.  The presence of vendor specific extensions will be detected by the value of the @c size parameter.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IVIDDEC1_Fxns::process()

---

Field Documentation

XDAS_Int32 IVIDANALYTICS_OutArgs::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int32 IVIDANALYTICS_OutArgs::numTargets

Number of targets detected

XDM_Rect IVIDANALYTICS_OutArgs::targets[128]

target locations.

                                @remarks   If @c numTargets is zero,
                                           the values in this array are
                                           undefined.

XDAS_Int32 IVIDANALYTICS_OutArgs::numEvents

Number of events detected

XDAS_Int32 IVIDANALYTICS_OutArgs::eventId[128]

Zero-terminated array containing the ids of rules fired during the process() call.

Remarks:

If numEvents is zero, the values in this array are undefined.

XDAS_Int32 IVIDANALYTICS_OutArgs::extendedError

Extended error information.

Remarks:

When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)

The value of each enum is the bit which is set.

Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.

The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

XDM_ErrorBit

XDM_Date IVIDANALYTICS_OutArgs::date

Current time.

---

The documentation for this struct was generated from the following file:

• cetools/packages/ti/xdais/dm/ividanalytics.h