EqualizerBandSetGain method

EqualizerBandSetGain method

Remarks

Modifies the gain of a given band of the equalizer.

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

Syntax

[Visual Basic]

Public Function EqualizerBandSetGain (

nPlayerIndex as Int16,

fFrequency as float,

fGain as float

) as float

[C#]

public float EqualizerBandSetGain (

Int16 nPlayerIndex,

float fFrequency,

float fGain

);

[C++]

public: float EqualizerBandSetGain (

Int16 nPlayerIndex,

float fFrequency,

float fGain

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
fFrequency	Frequency 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.