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

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

#include <isphenc1.h>

Collaboration diagram for ISPHENC1_DynamicParams:
Collaboration graph

Data Fields

XDAS_Int16 size
XDAS_Int16 frameSize
XDAS_Int16 bitRate
XDAS_Int16 mode
XDAS_Int16 vadFlag
 Voice Activity Detection (VAD) setting.
XDAS_Int16 noiseSuppressionMode
XDAS_Int16 ttyTddMode
XDAS_Int16 dtmfMode
XDAS_Int16 dataTransmit
XDAS_Int16 reserved

Detailed Description

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

@remarks    It is not necessary that a 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.

Field Documentation

XDAS_Int16 ISPHENC1_DynamicParams::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_DynamicParams::frameSize

Input frame size in bytes for sample based codecs.

XDAS_Int16 ISPHENC1_DynamicParams::bitRate

Optional, codec-specific bit rate. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_BitRate
ISPEECH1_G723_BitRate
ISPEECH1_WBAMR_BitRate
XDAS_Int16 ISPHENC1_DynamicParams::mode

Optional, codec-specific mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_Mode
ISPEECH1_SMV_Mode
XDAS_Int16 ISPHENC1_DynamicParams::vadFlag

Voice Activity Detection (VAD) setting.

See also:
ISPEECH1_VADFlag.
XDAS_Int16 ISPHENC1_DynamicParams::noiseSuppressionMode

Optional, codec-specific noise suppression mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_NoisePreProc
ISPEECH1_G723_NoisePreProc
ISPEECH1_SMV_NoisePreProc
XDAS_Int16 ISPHENC1_DynamicParams::ttyTddMode

Optional, codec-specific TTY mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_EVRC_TTYMode
ISPEECH1_SMV_TTYMode
XDAS_Int16 ISPHENC1_DynamicParams::dtmfMode

Optional, codec-specific DTMF mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_SMV_DTMFMode
XDAS_Int16 ISPHENC1_DynamicParams::dataTransmit

Optional, codec-specific data transmit mode. See your codec-specific interface documentation options.

See also:
ISPEECH1_SMV_DataMode
XDAS_Int16 ISPHENC1_DynamicParams::reserved

Reserved - serves to pad this structure.


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