Classes > EffectsMan class > Methods > Effects.DirectXApplyWavesReverb method

Remarks

Applies a Waves Reverb 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 DirectXApplyWavesReverb (

nStartPosition as Int32,

nEndPosition as Int32,

fx as Microsoft.DirectX.DirectSound.EffectsWavesReverb

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXApplyWavesReverb (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft.DirectX.DirectSound.EffectsWavesReverb fx

);

[C++]

public: enumErrorCodes DirectXApplyWavesReverb (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft::DirectX::DirectSound::EffectsWavesReverb 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

HighFrequencyRtRatio	Retrieves and sets the high-frequency reverb time ratio. Can range from WavesReverbEffect.HighFrequencyRtRationMin to WavesReverbEffect.HighFrequencyRtRationMax. The default value is 0.001 or WavesReverbEffect.HighFrequencyRtRationDefault.
InGain	Retrieves and sets the input gain of signal expressed in decibels (dB). Can range from WavesReverbEffect.InGainMin to WavesReverbEffect.InGainMax. The default value is 0 db or WavesReverbEffect.InGainDefault.
ReverbMix	Retrieves and sets the reverb mix expressed in decibels (dB). Can range from WavesReverbEffect.ReverbMixMin to WavesReverbEffect.ReverbMixMax. The default value is 0 db or WavesReverbEffect.ReverbMixDefault.
ReverbTime	Retrieves and sets the reverb time expressed in milliseconds. Can range from WavesReverbEffect.ReverbTimeMin to WavesReverbEffect.ReverbTimeMax. The default value is 1000 ms or WavesReverbEffect.ReverbTimeDefault.

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.