IAUDENC1_Status Struct Reference

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

#include <iaudenc1.h>

Collaboration diagram for IAUDENC1_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
	Extended error information.
XDM1_SingleBufDesc	data
XDM_AlgBufInfo	bufInfo
XDAS_Int32	validFlag
XDAS_Int32	lfeFlag
XDAS_Int32	bitRate
XDAS_Int32	sampleRate
XDAS_Int32	channelMode
XDAS_Int32	encMode

---

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

---

Field Documentation

XDAS_Int32 IAUDENC1_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 IAUDENC1_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_SingleBufDesc IAUDENC1_Status::data

Buffer descriptor for data passing.

                                @remarks   This buffer can be used as
                                           either input or output,
                                           depending on the command.

                                @remarks   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.

                                @sa    #XDM_GETVERSION

XDM_AlgBufInfo IAUDENC1_Status::bufInfo

Input and output buffer information.

                                @sa    XDM_AlgBufInfo

XDAS_Int32 IAUDENC1_Status::validFlag

Flag indicating the validity of the status struct.

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDENC1_Status::lfeFlag

Flag indicating whether LFE channel data is present or not in the input.

Valid values for this field are XDAS_TRUE and XDAS_FALSE.

XDAS_Int32 IAUDENC1_Status::bitRate

Average bit rate, in bits per second.

                                @sa    IAUDENC1_Params.bitRate
                                @sa    IAUDENC1_DynamicParams.bitRate

XDAS_Int32 IAUDENC1_Status::sampleRate

Sampling frequency in Hz. For example, if the sampling frequency is 44.1 kHz, this field will be 44100.

See also:

IAUDENC1_Params.sampleRate

IAUDENC1_DynamicParams.sampleRate

XDAS_Int32 IAUDENC1_Status::channelMode

Input Channel Mode.

                                @sa    IAUDIO_ChannelMode for valid values.
                                @sa    IAUDENC1_Params.channelMode
                                @sa    IAUDENC1_DynamicParams.channelMode

XDAS_Int32 IAUDENC1_Status::encMode

Encoding mode.

                                @sa    IAUDIO_EncMode
                                @sa    IAUDENC1_Params.encMode

---

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

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