Noatun API Documentation

VEqualizer Class Reference

Noatun EQ. More...

#include <vequalizer.h>

Inheritance diagram for VEqualizer:

Inheritance graph
[legend]
List of all members.

Public Slots

void setPreamp (int p)
void enable ()
void disable ()
void setEnabled (bool e)
void setBands (int bands)
void setBands (int bands, bool interpolate)

Signals

void changedBands ()
void changed ()
void modified ()
void preampChanged ()
void preampChanged (int)
void enabled ()
void disabled ()
void enabled (bool e)
void created (VPreset preset)
void selected (VPreset preset)
void renamed (VPreset preset)
void removed (VPreset preset)

Public Member Functions

int bands () const
int maxBands () const
int minBands () const
VBand band (int num)
bool isEnabled () const
int preamp () const
bool save (const KURL &file, const QString &friendly) const
bool load (const KURL &file)
QString toString (const QString &name="stored") const
bool fromString (const QString &str)
VPreset createPreset (const QString &name, bool smart=true)
QValueList< VPresetpresets () const
VPreset presetByName (const QString &name)
VPreset presetByFile (const QString &file)
bool presetExists (const QString &name) const

Static Public Member Functions

QValueList< int > frequencies (int num)
int start ()
int end ()

Detailed Description

Noatun EQ.

Author:
Charles Samuels

Definition at line 176 of file vequalizer.h.


Member Function Documentation

int VEqualizer::bands  )  const [virtual]
 

Returns:
number of bands I have, which may be different than what setBands was called with
See also:
setBands

Implements VBandsInterface.

void VEqualizer::changed  )  [signal]
 

emitted when something changes. Preamplication, band level, number of bands, enabled/disabled

void VEqualizer::changedBands  )  [signal]
 

emitted when the number of bands has changed (and hence all my associated Bands are useless

void VEqualizer::created VPreset  preset  )  [signal]
 

emitted when a preset is created

VPreset VEqualizer::createPreset const QString &  name,
bool  smart = true
 

create a preset with such a name and remember that it'l return an invalied Preset if the name already exists

If smart is true, append a number to the end of the name, if one already exists by the given

void VEqualizer::disable  )  [slot]
 

turn off EQ

void VEqualizer::enable  )  [slot]
 

turn on EQ

int VEqualizer::end  )  [static]
 

Returns:
last frequency I operate on, currently 20000

QValueList<int> VEqualizer::frequencies int  num  )  [static]
 

Returns:
the frequencies to use with num many bands. This is a list of the upper frequency of each band, for example: { 40, 60, 100 } if you hear up to 40hz

bool VEqualizer::fromString const QString &  str  ) 
 

undo a toString, restoring the EQ to the settings in the given string, emitting the changed signals

bool VEqualizer::load const KURL &  file  ) 
 

restore the EQ settings from this file

int VEqualizer::maxBands  )  const
 

Returns:
maximum amount of bands I may have

int VEqualizer::minBands  )  const
 

the minimum number of bands I may have (2)

void VEqualizer::modified  )  [signal]
 

emitted when the value of one or more of the bands has changed, but not immediately after a changedBands

int VEqualizer::preamp  )  const
 

returns the level of preamp (-100 to 100 normally)

VPreset VEqualizer::presetByFile const QString &  file  ) 
 

Returns:
the preset in the given file or an invalid Preset if none exists

VPreset VEqualizer::presetByName const QString &  name  ) 
 

Returns:
the preset with the given name or an invalid Preset if none exists

bool VEqualizer::presetExists const QString &  name  )  const
 

Returns:
whether a preset with the given name exists

QValueList<VPreset> VEqualizer::presets  )  const
 

return all the presets remember to setAutoDelete on this

void VEqualizer::removed VPreset  preset  )  [signal]
 

the given preset has been removed

void VEqualizer::renamed VPreset  preset  )  [signal]
 

when preset has been renamed

bool VEqualizer::save const KURL &  file,
const QString &  friendly
const
 

save the current levels all noatun equalizer files have the "*.noatunequalizer" pattern. Nevertheless, the file can be identified by magic, so it's not required

void VEqualizer::selected VPreset  preset  )  [signal]
 

emitted when the given preset is selected

void VEqualizer::setEnabled bool  e  )  [slot]
 

turn on/off EQ depending on e

void VEqualizer::setPreamp int  p  )  [slot]
 

set the preamplification it's logarithmic. 0 is no change negative numbers are loss in intensity positive numbers are a gain And +-100 is the most you'd need to go

int VEqualizer::start  )  [static]
 

Returns:
first frequency I operate on, currently 20
does not apply to an interpolation

QString VEqualizer::toString const QString &  name = "stored"  )  const
 

convert the current EQ settings to string form, suitable for storage, the given string is the title

See also:
fromString


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for Noatun 2.6.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 23:49:49 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003