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

Defines the creation time parameters for all IAUDENC instance objects. More...

#include <iaudenc.h>

Collaboration diagram for IAUDENC_Params:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 encodingPreset
XDAS_Int32 maxSampleRate
XDAS_Int32 maxBitrate
XDAS_Int32 maxNoOfCh
XDAS_Int32 dataEndianness

Detailed Description

Defines the creation time parameters for all IAUDENC instance objects.

@remarks    The application should set the parameters to 0 to use
            the algorithm's default values.

@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_Int32 IAUDENC_Params::size

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

XDAS_Int32 IAUDENC_Params::encodingPreset

Encoding Preset. See XDM_EncodingPreset.

XDAS_Int32 IAUDENC_Params::maxSampleRate

Maximum sampling frequency in Hz. For example, if the maximum sampling frequency is 44.1 kHz, this field should be 44100.

XDAS_Int32 IAUDENC_Params::maxBitrate

Maximum bit rate in bits per second. For example, if the maximum bit rate is 128 kbps, set this field to 128000.

XDAS_Int32 IAUDENC_Params::maxNoOfCh

Maximum Channels. See IAUDIO_ChannelId.

XDAS_Int32 IAUDENC_Params::dataEndianness

Endianness of output data.

                                @sa    XDM_DataFormat

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