EqSettings Class Reference

The EqSettings class helps to work with equalizer settings. More...

#include <eqsettings.h>

List of all members.

Public Types

enum  BANDS { EQ_BANDS_10 = 10, EQ_BANDS_15 = 15, EQ_BANDS_25 = 25, EQ_BANDS_31 = 31 }

Public Member Functions

 EqSettings (int bands=EQ_BANDS_10)
bool isEnabled () const
double gain (int chan) const
double preamp () const
int bands () const
void setEnabled (bool enabled=true)
void setGain (int band, double gain)
void setPreamp (double preamp)
void operator= (const EqSettings &s)
bool operator== (const EqSettings &s) const
bool operator!= (const EqSettings &s) const


Detailed Description

The EqSettings class helps to work with equalizer settings.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Member Enumeration Documentation

enum BANDS

Equalizer bands number

Enumerator:
EQ_BANDS_10  10 bands
EQ_BANDS_15  15 bands
EQ_BANDS_25  25 bands
EQ_BANDS_31  31 bands


Constructor & Destructor Documentation

EqSettings ( int  bands = EQ_BANDS_10  ) 

Constructs an empty equalizer settings (0 dB, disabled)

Parameters:
bands - Number of bands (supported: 10, 15, 25, 31)


Member Function Documentation

int bands (  )  const

Returns number of bands

double gain ( int  chan  )  const

Returns gain of the channel number chan.

bool isEnabled (  )  const

Returns true if equalizer os enabled, otherwise returns false.

bool operator!= ( const EqSettings s  )  const

Returns true if equalizer settins s is not equal to this settings; otherwise returns false.

void operator= ( const EqSettings s  ) 

Assigns equalizer settings s to this settings.

bool operator== ( const EqSettings s  )  const

Returns true if equalizer settins s is equal to this settings; otherwise returns false.

double preamp (  )  const

Returns equalizer preamp.

void setEnabled ( bool  enabled = true  ) 

Enables equalizer if enabled is true or disables it if enabled is false.

void setGain ( int  band,
double  gain 
)

Sets gain of the equalizer channel.

Parameters:
band Number of equalizer band.
gain Channel gain (-20.0..20.0 dB)

void setPreamp ( double  preamp  ) 

Sets equalizer preamp to preamp.


The documentation for this class was generated from the following file:

Generated on Thu Nov 10 20:39:11 2011 for Qmmp by  doxygen 1.5.9