vlc.AudioEqualizer

class vlc.AudioEqualizer

Bases: _Ctype

Create a new default equalizer, with all frequency values zeroed.

The new equalizer can subsequently be applied to a media player by invoking MediaPlayer.set_equalizer().

The returned handle should be freed via release() when it is no longer needed.

get_amp_at_index(u_band)

Get the amplification value for a particular equalizer frequency band.

Parameters:: u_band – index, counting from zero, of the frequency band to get.
Returns:: amplification value (Hz); NaN if there is no such frequency band.
Version:: LibVLC 2.2.0 or later.

get_preamp()

Get the current pre-amplification value from an equalizer.

release()

Release a previously created equalizer instance.

The equalizer was previously created by using new() or new_from_preset().

It is safe to invoke this method with a None p_equalizer parameter for no effect.

set_amp_at_index(f_amp, u_band)

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

The new equalizer settings are subsequently applied to a media player by invoking media_player_set_equalizer().

The supplied amplification value will be clamped to the -20.0 to +20.0 range.

Parameters:

Returns:

zero on success, -1 on error.

Version:

LibVLC 2.2.0 or later.

set_preamp(f_preamp)

Set a new pre-amplification value for an equalizer.

The new equalizer settings are subsequently applied to a media player by invoking media_player_set_equalizer().

The supplied amplification value will be clamped to the -20.0 to +20.0 range.