The QmmpSettings class provides access to global settings. More...

#include <qmmpsettings.h>

Public Types
enum	ReplayGainMode { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_DISABLED }
Signals
void	replayGainSettingsChanged ()
void	audioSettingsChanged ()
void	coverSettingsChanged ()
void	networkSettingsChanged ()
void	eqSettingsChanged ()
Public Member Functions
	QmmpSettings (QObject *parent=0)
virtual	~QmmpSettings ()
QmmpSettings::ReplayGainMode	replayGainMode () const
double	replayGainPreamp () const
double	replayGainDefaultGain () const
bool	replayGainPreventClipping () const
void	setReplayGainSettings (ReplayGainMode mode, double preamp, double default_gain, bool clip)
bool	useSoftVolume () const
Qmmp::AudioFormat	outputFormat () const
bool	useDithering () const
void	setAudioSettings (bool soft_volume, Qmmp::AudioFormat format, bool use_dithering)
QStringList	coverNameFilters (bool include=true) const
int	coverSearchDepth () const
bool	useCoverFiles () const
void	setCoverSettings (QStringList inc, QStringList exc, int depth, bool use_files)
bool	isProxyEnabled () const
bool	useProxyAuth () const
QUrl	proxy () const
void	setNetworkSettings (bool use_proxy, bool auth, const QUrl &proxy)
EqSettings	eqSettings () const
void	setEqSettings (const EqSettings &settings)
void	readEqSettings (int bands=EqSettings::EQ_BANDS_10)
int	bufferSize () const
void	setBufferSize (int msec)
void	setVolumeStep (int step)
int	volumeStep () const
void	setDetermineFileTypeByContent (bool enabled)
bool	determineFileTypeByContent () const
Static Public Member Functions
static QmmpSettings *	instance ()

Detailed Description

The QmmpSettings class provides access to global settings.

Author:: Ilya Kotov <forkotov02@hotmail.ru>

Member Enumeration Documentation

enum ReplayGainMode

This enum describes possible replaygain modes.

Enumerator:

REPLAYGAIN_TRACK	Use track gain/peak
REPLAYGAIN_ALBUM	Use album gain/peak
REPLAYGAIN_DISABLED	Disable ReplayGain

Constructor & Destructor Documentation

QmmpSettings ( QObject * parent = 0 )

Constructor.

Parameters:

parent Parent object. This functions is for internal usage only, use QmmpSettings::instance() instead.

virtual ~QmmpSettings ( ) [virtual]

Destructor.

Member Function Documentation

void audioSettingsChanged ( ) [signal]

Emitted when audio settings are changed.

int bufferSize ( ) const

Returns buffer size in milliseconds

QStringList coverNameFilters ( bool include = true ) const

If include is true, this function returns include cover file name filters, otherwise returns exclude filters.

int coverSearchDepth ( ) const

Returns a depth of recursive cover file search.

void coverSettingsChanged ( ) [signal]

Emitted when cover settings are changed.

bool determineFileTypeByContent ( ) const

Return true if content based file type determination is enabled. Otherwise returns false.

EqSettings eqSettings ( ) const

Returns equalizer settings.

void eqSettingsChanged ( ) [signal]

Emitted when equalizer settings are changed.

static QmmpSettings* instance ( ) [static]

Returns a pointer to the QmmpSettings instance.

bool isProxyEnabled ( ) const

Returns true if global proxy is enabled, otherwise returns false

void networkSettingsChanged ( ) [signal]

Emitted when network settings are changed.

Qmmp::AudioFormat outputFormat ( ) const

Returns preferd output format.

QUrl proxy ( ) const

Returns global proxy url.

void readEqSettings ( int bands = EqSettings::EQ_BANDS_10 )

Reads equalizer settings. Call this function before equalizer usage.

Parameters:

bands Number of bands.

double replayGainDefaultGain ( ) const

Returns default gain in dB.

QmmpSettings::ReplayGainMode replayGainMode ( ) const

Returns current ReplayGain mode.

double replayGainPreamp ( ) const

Returns preamp in dB.

bool replayGainPreventClipping ( ) const

Returns true if clipping prevention is enabled; otherwise returns false.

void replayGainSettingsChanged ( ) [signal]

Emitted when ReplayGain settings are changed.

void setAudioSettings	(	bool	soft_volume,
		Qmmp::AudioFormat	format,
		bool	use_dithering
	)

Sets audio settings.

Parameters:

soft_volume	State of software volume.
format	Preferd output format. Supported values: Qmmp::PCM_S16LE, Qmmp::PCM_S24LE, Qmmp::PCM_S32LE.
use_dithering	Enable/Disable audio dithering.

void setBufferSize ( int msec )

Sets buffer size

Parameters:

msec	Buffer size in milliseconds

void setCoverSettings	(	QStringList	inc,
		QStringList	exc,
		int	depth,
		bool	use_files
	)

Sets cover search options.

Parameters:

inc	Include cover name filters
exc	Exclude cover name filters
depth	Depth of recursive cover file search. Recursive cover file search can be disabled by setting depth to 0.
use_files	Use or not use files with covers. This parameter doesn't take effect in embedded covers.

void setDetermineFileTypeByContent ( bool enabled )

Enables/Disables file type determination by content

Parameters:

enabled State of the content based type determination (true - enabled, false - disabled)

void setEqSettings ( const EqSettings & settings )

Changes equalizer settings to settings

void setNetworkSettings	(	bool	use_proxy,
		bool	auth,
		const QUrl &	proxy
	)

Sets network settings.

Parameters:

use_proxy	Enables or disables global proxy.
auth	Enables or disables proxy authentication.
proxy	Proxy url.

void setReplayGainSettings	(	ReplayGainMode	mode,
		double	preamp,
		double	default_gain,
		bool	clip
	)

Sets ReplayGains settings.

Parameters:

mode	ReplayGain mode.
preamp	Preamp in dB.
default_gain	Default gain in dB.
clip	Clipping prevention state.

bool useCoverFiles ( ) const

Returns true if cover file search is enabled; otherwise returns false.

bool useDithering ( ) const

Returns true if dithering is enabled; otherwise returns false.

bool useProxyAuth ( ) const

Returns true if global proxy authentication is enabled, otherwise returns false

bool useSoftVolume ( ) const

Returns true if software volume is enabled; otherwise returns false.

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

/usr/src/RPM/BUILD/qmmp-0.10-svn/src/qmmp/qmmpsettings.h

Public Types

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation