Copyright © 2005-2018 MultiMedia Soft

Effects.EqualizerBandGainSet method

Previous pageReturn to chapter overviewNext page

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 EqualizerBandGainSet (

nPlayerIndex as Int16,

fFrequency As Single,

fGain as float

) as enumErrorCodes


 

[C#]

public enumErrorCodes EqualizerBandGainSet (

Int16 nPlayerIndex,

float fFrequency,

float fGain

);


 

[C++]

public: enumErrorCodes EqualizerBandGainSet (

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. Typical values are in the range from -15 to 15 dB but you can also enter values outside of this range.

 

 

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.