IVIDANALYTICS_Status Struct Reference
[XDM Beta Video Analytics Interface]

#include <ividanalytics.h>

Collaboration diagram for IVIDANALYTICS_Status:

Collaboration graph
[legend]

Detailed Description

Defines instance status parameters.

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 size parameter.

The size field must be correctly set by the caller.

See also:
IVIDANALYTICS_Fxns::control()


Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
XDM1_BufDesc data
XDM_AlgBufInfo bufInfo
XDAS_Int32 viewState

Field Documentation

XDAS_Int32 IVIDANALYTICS_Status::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_Status::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

XDM1_BufDesc IVIDANALYTICS_Status::data

Buffer descriptors for data passing.

Remarks:
If this field is not used, the application must set data.numBufs to 0.

These buffers can be used as either input or output, depending on the command.

The buffers will be provided by the application, and returned to the application upon return of the IVIDANALYTICS_Fxns.control() call. The algorithm must not retain a pointer to this data.

See also:
XDM_GETVERSION

XDM_AlgBufInfo IVIDANALYTICS_Status::bufInfo

Input and output buffer information.

Remarks:
This field provides the application with the algorithm's buffer requirements. The requirements may vary depending on the current configuration of the algorithm instance.
See also:
IVIDANALYTICS_Params

XDM_AlgBufInfo

IVIDANALYTICS_Fxns::control()

XDAS_Int32 IVIDANALYTICS_Status::viewState

View state of the analytics engine.

Remarks:
This enumeration data type should not be used for storage, but rather only for its constant values.
Todo:
Need to further review and define. Probably need hooks for user-defined states, in addition to some pre-defined ones.
See also:
IVIDANALYTICS_OutArgs::viewState

IVIDANALYTICS_Status::viewState

See also:
IVIDANALYTICS_ViewState

The documentation for this struct was generated from the following file:
Copyright 2009, Texas Instruments Incorporated