Home       Trees       Indices       Help   
Module vlc :: Class AudioEqualizer
[hide private]
[frames] | no frames]

Class AudioEqualizer

source code

object --+    
         |    
    _Ctype --+
             |
            AudioEqualizer

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 libvlc_audio_equalizer_release() when it is no longer needed.

Instance Methods [hide private]
 
release(self)
Release a previously created equalizer instance.		 source code
 
set_preamp(self, f_preamp)
Set a new pre-amplification value for an equalizer.		 source code
 
get_preamp(self)
Get the current pre-amplification value from an equalizer.		 source code
 
set_amp_at_index(self, f_amp, u_band)
Set a new amplification value for a particular equalizer frequency band.		 source code
 
get_amp_at_index(self, u_band)
Get the amplification value for a particular equalizer frequency band.		 source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
a new object with type S, a subtype of T
__new__(cls, *args) source code

Inherited from _Ctype: from_param

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(cls, *args)
Static Method

source code 
Returns: a new object with type S, a subtype of T
Overrides: object.__new__
(inherited documentation)

release(self)

source code 

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.

Version: LibVLC 2.2.0 or later.

set_preamp(self, f_preamp)

source code 

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.

Parameters:
  • f_preamp - preamp value (-20.0 to 20.0 Hz).
Returns:
zero on success, -1 on error.

Version: LibVLC 2.2.0 or later.

get_preamp(self)

source code 

Get the current pre-amplification value from an equalizer.

Returns:
preamp value (Hz).

Version: LibVLC 2.2.0 or later.

set_amp_at_index(self, f_amp, u_band)

source code 

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:
  • f_amp - amplification value (-20.0 to 20.0 Hz).
  • u_band - index, counting from zero, of the frequency band to set.
Returns:
zero on success, -1 on error.

Version: LibVLC 2.2.0 or later.

get_amp_at_index(self, u_band)

source code 

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.


   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat Jul 25 13:13:08 2020 http://epydoc.sourceforge.net