EqualizerBandGetParams method

EqualizerBandGetParams method

Remarks

Obtains parameters related to 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]

control.EqualizerBandGetParams (

nPlayer as Integer,

fFrequency as Single,

fBandWidth as Single,

fGain as Single

) as Single

[C++]

float control.EqualizerBandGetParams (

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
fBandWidth	Reference that, on return from the method call, will contain the width of the band expressed in Hertz
fGain	Reference that, on return from the method call, will contain the 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.