IAUDENC1_Status Struct Reference
[XDM IAUDENC1 Audio Encoder Interface]

Defines instance status parameters (read-only). More...

#include <iaudenc1.h>

Collaboration diagram for IAUDENC1_Status:

Detailed Description

Defines instance status parameters (read-only).

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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

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

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.

Buffer descriptor for data passing.

Remarks:: This buffer can be used as either input or output, depending on the command.; The buffer will be provided by the application, and returned to the application upon return of the control() call. The algorithm must not retain a pointer to this data.