Class Equalizer

Namespace

LibVLCSharp.Shared

Assembly

LibVLCSharp.dll

Equalizer settings can be applied to a media player using this type

public class Equalizer : Internal, IDisposable

Inheritance

object

Internal

Equalizer

Implements

IDisposable

Inherited Members

Internal.Release

Internal.IsDisposed

Internal.Dispose()

Internal.Dispose(bool)

Internal.NativeReference

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Equalizer()

Create a new default equalizer, with all frequency values zeroed. The new equalizer can subsequently be applied to a media player by invoking libvlc_media_player_set_equalizer(). version LibVLC 2.2.0 or later

public Equalizer()

Equalizer(uint)

Create a new equalizer, with initial frequency values copied from an existing preset. The new equalizer can subsequently be applied to a media player by invoking libvlc_media_player_set_equalizer(). version LibVLC 2.2.0 or later

public Equalizer(uint index)

Parameters

index uint

index of the preset, counting from zero

Properties

BandCount

Get the number of distinct frequency bands for an equalizer. return number of frequency bands LibVLC 2.2.0 or later

public uint BandCount { get; }

Property Value

uint

Preamp

Get the current pre-amplification value from an equalizer. return preamp value (Hz) LibVLC 2.2.0 or later

public float Preamp { get; }

Property Value

float

PresetCount

Get the number of equalizer presets. LibVLC 2.2.0 or later

public uint PresetCount { get; }

Property Value

uint

Methods

Amp(uint)

Get the amplification value for a particular equalizer frequency band. LibVLC 2.2.0 or later

public float Amp(uint band)

Parameters

band uint

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

Returns

float

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

BandFrequency(uint)

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. LibVLC 2.2.0 or later

public float BandFrequency(uint index)

Parameters

index uint

index index of the band, counting from zero

Returns

float

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

PresetName(uint)

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.

public string? PresetName(uint index)

Parameters

index uint

index of the preset, counting from zero

Returns

string

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

SetAmp(float, uint)

Set a new amplification value for a particular equalizer frequency band. The new equalizer settings are subsequently applied to a media player by invoking MediaPlayer::setEqualizer(). The supplied amplification value will be clamped to the -20.0 to +20.0 range. LibVLC 2.2.0 or later

public bool SetAmp(float amp, uint band)

Parameters

amp float

amplification value (-20.0 to 20.0 Hz)

band uint

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

Returns

bool

SetPreamp(float)

Set a new pre-amplification value for an equalizer. The new equalizer settings are subsequently applied to a media player by invoking MediaPlayer::setEqualizer(). The supplied amplification value will be clamped to the -20.0 to +20.0 range.

public bool SetPreamp(float preamp)

Parameters

preamp float

preamp value (-20.0 to 20.0 Hz)

Returns

bool

true on success, false otherwise