Copyright © 2011-2018 MultiMedia Soft

Effects.EqualizerBandGetParams method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters related to a given band of the equalizer.

 

For further details about defining the equalizer settings refer to the How to define an equalizer section.

For further details about methods related to the use of special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function EqualizerBandGetParams (

fFrequency as float,

ByRef fBandWidth as float,

ByRef fGain as float

) as float


 

[C#]

public float EqualizerBandGetParams (

float fFrequency,

ref float fBandWidth,

ref float fGain

);


 

[C++]

public: float EqualizerBandGetParams (

float fFrequency,

float __gc *fBandWidth,

float __gc *fGain

);


 

 

Parameter

Description

 

 

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 semi-tones

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.ERR_NOERROR (0)

The method call was successful.