Classes > EffectsMan class > Methods > Effects.DirectXApplyEcho method

Remarks

Applies a Echo 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 DirectXApplyEcho (

nStartPosition as Int32,

nEndPosition as Int32,

fx as Microsoft.DirectX.DirectSound.EffectsEcho

) as enumErrorCodes

[C#]

public enumErrorCodes DirectXApplyEcho (

Int32 nStartPosition,

Int32 nEndPosition,

Microsoft.DirectX.DirectSound.EffectsEcho fx

);

[C++]

public: enumErrorCodes DirectXApplyEcho (

Int32 nStartPosition,

Int32 nEndPosition,

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

Feedback	Retrieves and sets the percentage of output fed back into input. Can range from EchoEffect.FeedbackMin to EchoEffect.FeedbackMax. The default value is 50.
LeftDelay	Retrieves and sets the delay for left channel, in milliseconds. Can range from EchoEffect.LefttDelayMin to EchoEffect.LeftDelayMax. The default value is 500 ms.
PanDelay	Retrieves and sets the value that specifies whether to swap left and right delays with each successive echo. Can range from EchoEffect.PanDelayMin to EchoEffect.PanDelayMax. The default value is zero, meaning no swap.
RightDelay	Retrieves and sets the delay for right channel, in milliseconds. Can range from EchoEffect.RightDelayMin to EchoEffect.RightDelayMax. The default value is 500 ms.
WetDryMix	Retrieves and sets the ratio of wet (processed) signal to dry (unprocessed) signal. Can range from EchoEffect.WetDryMixMin to EchoEffect.WetDryMixMax.

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.