QmmpSettings Class Reference

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

#include <qmmpsettings.h>

List of all members.

Public Types
enum	ReplayGainMode { REPLAYGAIN_TRACK = 0, REPLAYGAIN_ALBUM, REPLAYGAIN_DISABLED }
Signals
void	replayGainSettingsChanged ()
void	audioSettingsChanged ()
void	coverSettingsChanged ()
void	networkSettingsChanged ()
Public Member Functions
	QmmpSettings (QObject *parent=0)
	~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
bool	use16BitOutput () const
void	setAudioSettings (bool soft_volume, bool use_16bit)
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)
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 QmmpSettings::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::QmmpSettings

(

QObject *

parent = 0

)

Constructor.

Parameters:

parent

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

QmmpSettings::~QmmpSettings

(

)

Destructor.

---

Member Function Documentation

void QmmpSettings::audioSettingsChanged

(

)

[signal]

Emitted when audio settings are changed.

QStringList QmmpSettings::coverNameFilters

(

bool

include = true

)

const

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

int QmmpSettings::coverSearchDepth

(

)

const

Returns a depth of recursive cover file search.

void QmmpSettings::coverSettingsChanged

(

)

[signal]

Emitted when cover settings are changed.

static QmmpSettings* QmmpSettings::instance

(

)

[static]

Returns a pointer to the QmmpSettings instance.

bool QmmpSettings::isProxyEnabled

(

)

const

Returns true if global proxy is enabled, otherwise returns false

void QmmpSettings::networkSettingsChanged

(

)

[signal]

Emitted when network settings are changed.

QUrl QmmpSettings::proxy

(

)

const

Returns global proxy url.

double QmmpSettings::replayGainDefaultGain

(

)

const

Returns default gain in dB.

QmmpSettings::ReplayGainMode QmmpSettings::replayGainMode

(

)

const

Returns current ReplayGain mode.

double QmmpSettings::replayGainPreamp

(

)

const

Returns preamp in dB.

bool QmmpSettings::replayGainPreventClipping

(

)

const

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

void QmmpSettings::replayGainSettingsChanged

(

)

[signal]

Emitted when ReplayGain settings are changed.

void QmmpSettings::setAudioSettings	(	bool	soft_volume,
		bool	use_16bit
	)

Sets audio settings.

Parameters:

	soft_volume	State of software volume.
	use_16bit	State of the 16-bit audio converter.

void QmmpSettings::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 QmmpSettings::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 QmmpSettings::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 QmmpSettings::use16BitOutput

(

)

const

Returns true if 16-bit converter is enabled; otherwise returns false.

bool QmmpSettings::useCoverFiles

(

)

const

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

bool QmmpSettings::useProxyAuth

(

)

const

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

bool QmmpSettings::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.4-svn/src/qmmp/qmmpsettings.h