EqualizerBandAdd method

EqualizerBandAdd method

Remarks

Adds a new band to the equalizer.

For further details about defining the equalizer settings refer to the How to create and use an Equalizer section.

Syntax

[Visual Basic]

control.EqualizerBandAdd (

nPlayer as Integer,

fFrequency as Single,

fBandWidth as Single,

fGain as Single

) as Single

[C++]

float control.EqualizerBandAdd (

short nPlayer,

float fFrequency,

float fBandWidth,

float fGain

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player
fFrequency	Frequency of the band expressed in Hertz. 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 Hertz
fGain	Gain of the band expressed in dB

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.