IVIDENC_Status Struct Reference

Defines instance status parameters. More...

#include <ividenc.h>

Collaboration diagram for IVIDENC_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
	Extended error information.
XDM_AlgBufInfo	bufInfo

---

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 @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         IVIDENC_Fxns::control()

---

Field Documentation

XDAS_Int32 IVIDENC_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 IVIDENC_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

XDM_AlgBufInfo IVIDENC_Status::bufInfo

Input and output buffer information.

                                @sa    XDM_AlgBufInfo

---

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

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