IAUDENC1_DynamicParams Struct Reference
[XDM IAUDENC1 Audio Encoder Interface]

#include <iaudenc1.h>

Detailed Description

This structure defines the algorithm 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.

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 size parameter.

The size field must be correctly set by the caller.

See also:
IAUDENC1_Fxns::control()


Data Fields

XDAS_Int32 size
XDAS_Int32 bitRate
XDAS_Int32 sampleRate
XDAS_Int32 channelMode
XDAS_Int32 lfeFlag
XDAS_Int32 dualMonoMode
XDAS_Int32 inputBitsPerSample

Field Documentation

XDAS_Int32 IAUDENC1_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 IAUDENC1_DynamicParams::bitRate

Average bit rate, in bits per second.

See also:
IAUDENC1_Params.bitRate

IAUDENC1_Status.bitRate

XDAS_Int32 IAUDENC1_DynamicParams::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_Status.sampleRate

XDAS_Int32 IAUDENC1_DynamicParams::channelMode

Input Channel Mode.

See also:
IAUDIO_ChannelMode

IAUDENC1_Params.channelMode

XDAS_Int32 IAUDENC1_DynamicParams::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_DynamicParams::dualMonoMode

Mode to indicate type of Dual Mono. Applicable only if channelMode is dualMono

See also:
IAUDIO_DualMonoMode

IAUDENC1_Params.dualMonoMode

XDAS_Int32 IAUDENC1_DynamicParams::inputBitsPerSample

Number of input bits per output sample. For example, if there are 16 bits per PCM input sample, this should be set to 16.

See also:
IAUDENC1_Params.inputBitsPerSample

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