Remarks
Sets parameters related to the Echo effect. The current parameters for the chosen effect can be retrieved using the Effects.DirectXEffectParamsGet method.
DirectX effects requires the availability of DirectX version 8 or higher on the target system and can be applied only if the IsDirectX8Available method returns TRUE.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic]
Public Function DirectXEffectParamsSet (
nPlayerIndex as Int16,
ByRef fx as Microsoft.DirectX.DirectSound.EffectsEcho
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes DirectXEffectParamsSet (
Int16 nPlayerIndex,
ref Microsoft.DirectX.DirectSound.EffectsEcho fx
);
|
|
[C++]
public: enumErrorCodes DirectXEffectParamsSet (
Int16 nPlayerIndex,
Microsoft::DirectX::DirectSound::EffectsEcho __gc *fx
);
|
|
Parameter
|
Description
|
|
|
nPlayerIndex
|
Number representing the zero-based index of the involved player
|
fx
|
Reference to the 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)
Note that if you should fill the fx structure with values out of range, you could get an exception of type ArgumentException
|
enumErrorCodes.NOERROR (0)
|
The method call was successful.
|
|
