#include <qmmpsettings.h>

Inherits QObject.

Public Types
enum	ReplayGainMode { REPLAYGAIN_TRACK = 0 , REPLAYGAIN_ALBUM , REPLAYGAIN_DISABLED }

enum	ProxyType { HTTP_PROXY = 0 , SOCKS5_PROXY }

Signals
void	replayGainSettingsChanged ()

void	audioSettingsChanged ()

void	coverSettingsChanged ()

void	networkSettingsChanged ()

void	eqSettingsChanged ()

Public Member Functions
	QmmpSettings (QObject *parent=nullptr)

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)

const 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

const QUrl &	proxy () const

ProxyType	proxyType () const

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

const EqSettings &	eqSettings () const

void	setEqSettings (const EqSettings &settings)

void	readEqSettings (EqSettings::Bands bands=EqSettings::EQ_BANDS_10)

int	bufferSize () const

void	setBufferSize (int msec)

void	setVolumeStep (int step)

int	volumeStep () const

void	setAverageBitrate (bool enabled)

bool	averageBitrate () 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 forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Member Enumeration Documentation

◆ ProxyType

enum ProxyType

This enum describes proxy types.

Enumerator
HTTP_PROXY	HTTP proxy
SOCKS5_PROXY	SOCKS5 proxy

◆ ReplayGainMode

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()

QmmpSettings ( QObject * parent = nullptr )

Constructor.

Parameters

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

◆ ~QmmpSettings()

virtual ~QmmpSettings ( )

virtual

Destructor.

Member Function Documentation

◆ audioSettingsChanged

void audioSettingsChanged ( )

signal

Emitted when audio settings are changed.

◆ averageBitrate()

bool averageBitrate ( ) const

Returns true if average bitrate displaying is enabled, otherwise returns false

◆ bufferSize()

int bufferSize ( ) const

Returns buffer size in milliseconds.

◆ coverNameFilters()

const QStringList& coverNameFilters ( bool include = true ) const

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

◆ coverSearchDepth()

int coverSearchDepth ( ) const

Returns a depth of recursive cover file search.

◆ coverSettingsChanged

void coverSettingsChanged ( )

signal

Emitted when cover settings are changed.

◆ determineFileTypeByContent()

bool determineFileTypeByContent ( ) const

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

◆ eqSettings()

const EqSettings& eqSettings ( ) const

Returns equalizer settings.

◆ eqSettingsChanged

void eqSettingsChanged ( )

signal

Emitted when equalizer settings are changed.

◆ instance()

static QmmpSettings* instance ( )

static

Returns a pointer to the QmmpSettings instance.

◆ isProxyEnabled()

bool isProxyEnabled ( ) const

Returns true if global proxy is enabled, otherwise returns false

◆ networkSettingsChanged

void networkSettingsChanged ( )

signal

Emitted when network settings are changed.

◆ outputFormat()

Qmmp::AudioFormat outputFormat ( ) const

Returns preferd output format.

◆ proxy()

const QUrl& proxy ( ) const

Returns global proxy url.

◆ proxyType()

ProxyType proxyType ( ) const

Returls global proxy type.

◆ readEqSettings()

void readEqSettings ( EqSettings::Bands bands = EqSettings::EQ_BANDS_10 )

Reads equalizer settings. Call this function before equalizer usage.

Parameters

bands Number of bands.

◆ replayGainDefaultGain()

double replayGainDefaultGain ( ) const

Returns default gain in dB.

◆ replayGainMode()

QmmpSettings::ReplayGainMode replayGainMode ( ) const

Returns current ReplayGain mode.

◆ replayGainPreamp()

double replayGainPreamp ( ) const

Returns preamp in dB.

◆ replayGainPreventClipping()

bool replayGainPreventClipping ( ) const

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

◆ replayGainSettingsChanged

void replayGainSettingsChanged ( )

signal

Emitted when ReplayGain settings are changed.

◆ setAudioSettings()

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.

◆ setAverageBitrate()

void setAverageBitrate ( bool enabled )

Enables/Disables average bitrate displaying.

Parameters

enabled State of the average bitrate displaying (true - enabled, false - disabled). This function emits audioSettingsChanged() signal.

◆ setBufferSize()

void setBufferSize ( int msec )

Sets buffer size.

Parameters

msec	Buffer size in milliseconds.

◆ setCoverSettings()

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.

◆ setDetermineFileTypeByContent()

void setDetermineFileTypeByContent ( bool enabled )

Enables/Disables file type determination by content.

Parameters

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

◆ setEqSettings()

void setEqSettings ( const EqSettings & settings )

Changes equalizer settings to settings.

◆ setNetworkSettings()

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

Sets network settings.

Parameters

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

◆ setReplayGainSettings()

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.

◆ setVolumeStep()

void setVolumeStep ( int step )

Sets volume adjustment step.

Parameters

step	Volume adjustment step in percent.

◆ useCoverFiles()

bool useCoverFiles ( ) const

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

◆ useDithering()

bool useDithering ( ) const

Returns true if dithering is enabled; otherwise returns false.

◆ useProxyAuth()

bool useProxyAuth ( ) const

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

◆ useSoftVolume()

bool useSoftVolume ( ) const

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

◆ volumeStep()

int volumeStep ( ) const

Returns volume adjustment step.

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

/usr/src/RPM/BUILD/qmmp-1.6.2/src/qmmp/qmmpsettings.h

Public Types

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ProxyType

◆ ReplayGainMode

Constructor & Destructor Documentation

◆ QmmpSettings()

◆ ~QmmpSettings()

Member Function Documentation

◆ audioSettingsChanged

◆ averageBitrate()

◆ bufferSize()

◆ coverNameFilters()

◆ coverSearchDepth()

◆ coverSettingsChanged

◆ determineFileTypeByContent()

◆ eqSettings()

◆ eqSettingsChanged

◆ instance()

◆ isProxyEnabled()

◆ networkSettingsChanged

◆ outputFormat()

◆ proxy()

◆ proxyType()

◆ readEqSettings()

◆ replayGainDefaultGain()

◆ replayGainMode()

◆ replayGainPreamp()

◆ replayGainPreventClipping()

◆ replayGainSettingsChanged

◆ setAudioSettings()

◆ setAverageBitrate()

◆ setBufferSize()

◆ setCoverSettings()

◆ setDetermineFileTypeByContent()

◆ setEqSettings()

◆ setNetworkSettings()

◆ setReplayGainSettings()

◆ setVolumeStep()

◆ useCoverFiles()

◆ useDithering()

◆ useProxyAuth()

◆ useSoftVolume()

◆ volumeStep()