ISPHENC_Status Struct Reference

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

#include <isphenc.h>

Collaboration diagram for ISPHENC_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
	Extended error information.
XDAS_Int32	frameSize
XDAS_Int32	bitRate
XDAS_Int32	mode
XDAS_Int32	vadFlag
XDAS_Int32	noiseSuppressionMode
XDAS_Int32	ttyTddMode
XDAS_Int32	dtmfMode
XDAS_Int32	dataTransmit
XDAS_Int32	homingMode
XDM_AlgBufInfo	bufInfo

---

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

---

Field Documentation

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

XDAS_Int32 ISPHENC_Status::frameSize

Input frame size in bytes for sample based codecs

XDAS_Int32 ISPHENC_Status::bitRate

Rate selection for multi_rate codecs

XDAS_Int32 ISPHENC_Status::mode

Mode selection for multi_mode codecs

XDAS_Int32 ISPHENC_Status::vadFlag

VAD_On =1, VAD_OFF = 0

XDAS_Int32 ISPHENC_Status::noiseSuppressionMode

0 - OFF, 1 = NS-A, 2 = NS-B etc

XDAS_Int32 ISPHENC_Status::ttyTddMode

0 = TTY OFF, 1 = 45.45bauds 2 = 50 bauds

XDAS_Int32 ISPHENC_Status::dtmfMode

0 = DTMF_OFF, 1 = DTMF_ON

XDAS_Int32 ISPHENC_Status::dataTransmit

1 = ON, 0 = OFF

XDAS_Int32 ISPHENC_Status::homingMode

0 - DISABLED; 1 - ENABLED

XDM_AlgBufInfo ISPHENC_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/isphenc.h