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]

Public Function EqualizerBandGetParams (

nPlayerIndex as Int16,

fFrequency as float,

ByRef fBandWidth as float,

ByRef fGain as float

) as float

[C#]

public float EqualizerBandGetParams (

Int16 nPlayerIndex,

float fFrequency,

ref float fBandWidth,

ref float fGain

);

[C++]

public: float EqualizerBandGetParams (

Int16 nPlayerIndex,

float fFrequency,

float __gc *fBandWidth,

float __gc *fGain

);

Parameter	Description

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