VlcEqualizer Class Reference

Audio equalizer. More...

#include <VLCQtCore/Equalizer.h>

Public Slots
void	loadFromPreset (uint index)
	Load from preset. More...
void	setAmplificationForBandAt (float amp, uint bandIndex)
	Set a new amplification value for a particular equalizer frequency band. More...
void	setEnabled (bool enabled)
	Enable or disable equalizer. More...
void	setPreamplification (float value)
	Set a new pre-amplification value for an equalizer. More...

Signals
void	presetLoaded ()
	Emitted when preset is loaded.

Public Member Functions
	VlcEqualizer (VlcMediaPlayer *vlcMediaPlayer)
	VlcEqualizer constructor.
	~VlcEqualizer ()
	VlcEqualizer destructor.
float	amplificationForBandAt (uint bandIndex) const
	Get the amplification value for a particular equalizer frequency band. More...
uint	bandCount () const
	Get the number of distinct frequency bands for an equalizer. More...
float	bandFrequency (uint bandIndex) const
	Get a particular equalizer band frequency. More...
float	preamplification () const
	Get the current pre-amplification value from an equalizer. More...
uint	presetCount () const
	Get the number of equalizer presets. More...
QString	presetNameAt (uint index) const
	Get the name of a particular equalizer preset. More...

Detailed Description

Audio equalizer.

Since

libVLC 2.2

Member Function Documentation

float VlcEqualizer::amplificationForBandAt

(

uint

bandIndex

)

const

Get the amplification value for a particular equalizer frequency band.

Parameters

bandIndex

index, counting from zero, of the frequency band to get

Returns

amplification value (Hz); -1.0 if there is no such frequency band

uint VlcEqualizer::bandCount

(

)

const

Get the number of distinct frequency bands for an equalizer.

Returns

number of frequency bands

float VlcEqualizer::bandFrequency

(

uint

bandIndex

)

const

Get a particular equalizer band frequency.

This value can be used, for example, to create a label for an equalizer band control in a user interface.

Parameters

bandIndex

index of the band, counting from zero

Returns

equalizer band frequency (Hz), or -1 if there is no such band

void VlcEqualizer::loadFromPreset ( uint  index )

slot

Load from preset.

Parameters

index

index of the preset, counting from zero

float VlcEqualizer::preamplification

(

)

const

Get the current pre-amplification value from an equalizer.

Returns

preamp value (Hz)

uint VlcEqualizer::presetCount

(

)

const

Get the number of equalizer presets.

Returns

number of presets

QString VlcEqualizer::presetNameAt

(

uint

index

)

const

Get the name of a particular equalizer preset.

This name can be used, for example, to prepare a preset label or menu in a user interface.

Parameters

index

index of the preset, counting from zero

Returns

preset name, or an empty string if there is no such preset

void VlcEqualizer::setAmplificationForBandAt ( float  amp, uint  bandIndex  )

slot

Set a new amplification value for a particular equalizer frequency band.

The new equalizer settings are subsequently applied to a media player by invoking libvlc_media_player_set_equalizer(). The supplied amplification value will be clamped to the -20.0 to +20.0 range.

Parameters

amp	amplification value (-20.0 to 20.0 Hz)
bandIndex	counting from zero, of the frequency band to set

void VlcEqualizer::setEnabled ( bool  enabled )

slot

Enable or disable equalizer.

Parameters

enabled

toggle flag

void VlcEqualizer::setPreamplification ( float  value )

slot

Set a new pre-amplification value for an equalizer.

The new equalizer settings are subsequently applied to a media player by invoking libvlc_media_player_set_equalizer(). The supplied amplification value will be clamped to the -20.0 to +20.0 range.

Parameters

value

preamp value in (-20.0 to 20.0 Hz)

---

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

• Equalizer.h
• Equalizer.cpp