[Visual Basic]

Public Function EqualizerBandAdd (

nPlayerIndex as Int16,

fFrequency As Single,

fBandWidth As Single,

fGain As Single

) as enumErrorCodes

[C#]

public enumErrorCodes EqualizerBandAdd (

Int16 nPlayerIndex,

float fFrequency,

float fBandWidth,

float fGain

);

[C++]

public: enumErrorCodes EqualizerBandAdd (

Int16 nPlayerIndex,

float fFrequency,

float fBandWidth,

float fGain

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the involved player

fFrequency

Center frequency of the band expressed in Hertz. Accepted values can be in the range from 1 to 16000 Hz.

A band's frequency cannot exceed one-third of the frequency of the sound under editing so, if you have loaded a sound with a frequency of 44100 Hz, the maximum allowed band's frequency will be 14700 Hz (14700 * 3 = 44100); in order to reach a band's frequency of 16000 Hz, you must load sounds whose frequency is at least 48000 Hz.

If a band for this specific frequency should already exist, it would be automatically replaced.

fBandWidth

Width of the band expressed in semi-tones

fGain

Gain of the band expressed in dB. Typical values are in the range from -15 to 15 dB but you can also enter values outside of this range.

Value

Meaning

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.