XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
IAUDENC_OutArgs Struct Reference

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

#include <iaudenc.h>

Collaboration diagram for IAUDENC_OutArgs:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
 Extended error information.
XDAS_Int32 bytesGenerated

Detailed Description

Defines the run time output arguments for all IAUDENC 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 size parameter.
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.
See also:
IAUDENC_Fxns::process()

Field Documentation

XDAS_Int32 IAUDENC_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 IAUDENC_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
XDAS_Int32 IAUDENC_OutArgs::bytesGenerated

Number of bytes generated during the process() call.


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