ISPHENC1_OutArgs Struct Reference
[XDM ISPHENC1 Speech/Voice Encoder Interface]

#include <isphenc1.h>

Detailed Description

Defines the run time output arguments for all ISPHENC1 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 also:
ISPHENC1_Fxns::process()


Data Fields

XDAS_Int16 size
XDAS_Int16 frameType
XDAS_Int32 extendedError

Field Documentation

XDAS_Int16 ISPHENC1_OutArgs::size

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

XDAS_Int16 ISPHENC1_OutArgs::frameType

Encoder frame types.

See also:
ISPHENC1_FrameType

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

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