Codec Engine Application Programming Interface (API)  ce-w08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
ISPHENC_DynamicParams Struct Reference
ISPHENC - XDM Speech Encoder Interface

This structure defines the codec parameters that can be modified after creation via control() calls. More...

#include <isphenc.h>

Collaboration diagram for ISPHENC_DynamicParams:
Collaboration graph

Data Fields

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

Detailed Description

This structure defines the codec parameters that can be modified after creation via control() calls. 

@remarks    It is not necessary that given implementation support all
            dynamic parameters to be configurable at run time.  If a
            particular algorithm does not support run-time updates to
            a parameter that the application is attempting to change
            at runtime, it may indicate this as an error.

@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_DynamicParams::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_DynamicParams::frameSize

Input frame size in bytes for sample based codecs.

XDAS_Int32 ISPHENC_DynamicParams::bitRate

Rate selection for multi_rate codecs

XDAS_Int32 ISPHENC_DynamicParams::mode

Mode selection for multi_mode codecs

XDAS_Int32 ISPHENC_DynamicParams::vadFlag

VAD_On =1, VAD_OFF = 0

XDAS_Int32 ISPHENC_DynamicParams::noiseSuppressionMode

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

XDAS_Int32 ISPHENC_DynamicParams::ttyTddMode

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

XDAS_Int32 ISPHENC_DynamicParams::dtmfMode

0 = DTMF_OFF, 1 = DTMF_ON

XDAS_Int32 ISPHENC_DynamicParams::dataTransmit

1 = ON, 0 = OFF

XDAS_Int32 ISPHENC_DynamicParams::homingMode

0 - DISABLED; 1 - ENABLED

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