Parametric Equalizer control functions.


Detailed Description

These functions implement Parametric Equalizer settings.


Functions

ASX32_API ASX_ERROR ASX_EQ_GetInfo (ASX_HANDLE hParmEq, unsigned short *pwNumberOfBands, unsigned short *pwEnabled)
 Gets information on the equalizer.
ASX32_API ASX_ERROR ASX_EQ_SetState (ASX_HANDLE hParmEq, const unsigned short wOnOff)
 Turns the equalizer on or off.
ASX32_API ASX_ERROR ASX_EQ_SetBand (ASX_HANDLE hParmEq, const unsigned short wIndex, const enum asxEQBANDTYPE eType, const unsigned long dwFrequencyHz, const short nQ100, const short nGain0_01dB)
 Sets the parameters for an equalizer band.
ASX32_API ASX_ERROR ASX_EQ_GetBand (ASX_HANDLE hParmEq, const unsigned short wIndex, enum asxEQBANDTYPE *peType, unsigned long *pdwFrequencyHz, short *pnQ100, short *pnGain0_01dB)
 Gets the parameters for an equalizer band.


Function Documentation

ASX32_API ASX_ERROR ASX_EQ_GetBand ASX_HANDLE  hParmEq,
const unsigned short  wIndex,
enum asxEQBANDTYPE peType,
unsigned long *  pdwFrequencyHz,
short *  pnQ100,
short *  pnGain0_01dB
 

Gets the parameters for an equalizer band.

Parameters:
hParmEq A handle to an ASX Parametric Equalizer control object.
wIndex Zero based index of the band, should be between zero and nBands - 1. where nBands is the number of bands from a call to ASX_EQ_GetInfo().
peType Receives the type of the band.
pdwFrequencyHz Receives the cutoff (for high/lo types) or center frequency (for band types).
pnQ100 Receives the sharpness (for high/lo types) or bandwidth (for band types). Value can be positive or negative and is given in hundreths (nQ100 = 72 means Q = 0.72).
pnGain0_01dB Receives the gain for equalizer, high shelf and low shelf filter types. Value can be positive or negative (0 is unity gain) and is given in hundreths.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_EQ_GetInfo ASX_HANDLE  hParmEq,
unsigned short *  pwNumberOfBands,
unsigned short *  pwEnabled
 

Gets information on the equalizer.

Parameters:
hParmEq A handle to an ASX Parametric Equalizer control object.
pwNumberOfBands Receives the number of bands.
pwEnabled Receives the on/off state of the equalizer.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_EQ_SetBand ASX_HANDLE  hParmEq,
const unsigned short  wIndex,
const enum asxEQBANDTYPE  eType,
const unsigned long  dwFrequencyHz,
const short  nQ100,
const short  nGain0_01dB
 

Sets the parameters for an equalizer band.

Parameters:
hParmEq A handle to an ASX Parametric Equalizer control object.
wIndex Zero based index of the band, should be between zero and nBands - 1. where nBands is the number of bands from a call to ASX_EQ_GetInfo().
eType Specifies the effect of the band.
dwFrequencyHz Specifies the cutoff (for high/lo types) or center frequency (for band types).
nQ100 Specifies the sharpness (for high/lo types) or bandwidth (for band types). Value can be positive or negative and is given in hundreths (nQ100 = 72 means Q = 0.72).
nGain0_01dB Specifies the gain for equalizer, high shelf and low shelf filter types. Value can be positive or negative (0 is unity gain) and is given in hundreths.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_EQ_SetState ASX_HANDLE  hParmEq,
const unsigned short  wOnOff
 

Turns the equalizer on or off.

Parameters:
hParmEq A handle to an ASX Parametric Equalizer control object.
wOnOff 1 = Turn equalizer on. 0 = Turn equalizer off.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.


Generated on Tue Nov 18 13:03:41 2008 for ASX by  doxygen 1.4.6-NO