Classes > EffectsMan class > Methods > Effects.DirectXApplyParamEq method

Remarks

Applies a Parametric equalizer effect to the given portion of sound under editing.

DirectX effects requires the availability of DirectX version 8 or higher on the target system and can be applied only if a call to the GetDirectSoundVersion method returns a value higher than 7.

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

Syntax

[Visual Basic]

Public Function DirectXApplyParamEq (

nStartPosition as Int32,

nEndPosition as Int32,

fx as Microsoft.DirectX.DirectSound.EffectsParamEq

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXApplyParamEq (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft.DirectX.DirectSound.EffectsParamEq fx

);

[C++]

public: enumErrorCodes DirectXApplyParamEq (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft::DirectX::DirectSound::EffectsParamEq fx

);

Parameter

Description

nStartPosition

Start position, expressed in milliseconds, of the affected sound range.

nEndPosition

End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound.

Effect structure containing parameters to apply.

Property	Meaning

Bandwidth	Retrieves and sets the bandwidth expressed in semitones. Can range from ParamEqEffect.BandwidthMin to ParamEqEffect.BandwidthMax. The default value is 12.
Center	Retrieves and sets the center frequency expressed in hertz. Can range from ParamEqEffect.CenterMin to ParamEqEffect.CenterMax. The default value is 8000.
Gain	Retrieves and sets the gain. Can range from ParamEqEffect.GainMin to ParamEqEffect.GainMax. The default value is 0.

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.