vlc.AudioEqualizer
==================

.. py:class:: vlc.AudioEqualizer

   Bases: :py:obj:`_Ctype`


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

   The new equalizer can subsequently be applied to a media player by invoking
   :meth:`MediaPlayer.set_equalizer`.

   The returned handle should be freed via :meth:`release` when
   it is no longer needed.



   .. py:method:: get_amp_at_index(u_band)

      Get the amplification value for a particular equalizer frequency band.

      :param u_band: index, counting from zero, of the frequency band to get.

      :return: amplification value (Hz); NaN if there is no such frequency band.
      :version: LibVLC 2.2.0 or later.



   .. py:method:: get_preamp()

      Get the current pre-amplification value from an equalizer.

      :return: preamp value (Hz).
      :version: LibVLC 2.2.0 or later.



   .. py:method:: release()

      Release a previously created equalizer instance.

      The equalizer was previously created by using :func:`new` or
      :func:`new_from_preset`.

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

      :version: LibVLC 2.2.0 or later.



   .. py:method:: 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
      :func:`media_player_set_equalizer`.

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

      :param f_amp: amplification value (-20.0 to 20.0 Hz).
      :param u_band: index, counting from zero, of the frequency band to set.

      :return: zero on success, -1 on error.
      :version: LibVLC 2.2.0 or later.



   .. py:method:: 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
      :func:`media_player_set_equalizer`.

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

      :param f_preamp: preamp value (-20.0 to 20.0 Hz).

      :return: zero on success, -1 on error.
      :version: LibVLC 2.2.0 or later.