EffectsEcho Structure (Microsoft.DirectX.DirectSound)

  • Article

How Do I...?

  • Use Effect Parameters

Contains parameters for an echo effect.

Definition

Visual Basic Public Structure EffectsEcho
C# public struct EffectsEcho 
C++ public value class EffectsEcho sealed 
JScript In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object.

Methods

Method Description
EffectsEcho Initializes a new instance of the EffectsEcho structure.
ToString Obtains a string representation of the current instance.

Properties

Property Description
Feedback Retrieves and sets the percentage of output fed back into input, in the EffectsEcho structure.
LeftDelay Retrieves and sets the delay for left channel, in milliseconds, in the EffectsEcho structure.
PanDelay Retrieves and sets the value that specifies whether to swap left and right delays with each successive echo, in the EffectsEcho structure.
RightDelay Retrieves and sets the delay for right channel, in milliseconds, in the EffectsEcho structure.
WetDryMix Retrieves and sets the ratio of wet (processed) signal to dry (unprocessed) signal in the EffectsEcho structure.

How Do I...?

Use Effect Parameters

This C# example demonstrates how to use the parameters of an effect object from a SecondaryBuffer object.

The buffer object in this code snippet is assumed to be the SecondaryBuffer from the code in Add Effects to a SecondaryBuffer Object.

              [C#]
              


//Retrieve the effects object and
//the effect param sturctures and edit parameters.
EchoEffect echo = (EchoEffect)buffer.GetEffects(0);
EffectsEcho echo_params = echo.AllParameters;

echo_params.LeftDelay = 250.0f;
echo_params.RightDelay = 100.0f;
echo_params.Feedback = 85.0f;
echo_params.PanDelay = 1;
echo_params.WetDryMix = 50.0f;

ChorusEffect chorus = (ChorusEffect)buffer.GetEffects(1);
EffectsChorus chorus_params = chorus.AllParameters;

chorus_params.Delay = 15.0f;
chorus_params.Depth = ChorusEffect.DepthMax;
chorus_params.Phase = ChorusEffect.PhaseNegative90;
chorus_params.Waveform = ChorusEffect.WaveSin;
chorus_params.WetDryMix = 50.0f;

//Set the new parameters and play the buffer.
echo.AllParameters = echo_params;
chorus.AllParameters = chorus_params;
buffer.Play(0,BufferPlayFlags.Default);

Structure Information

Namespace Microsoft.DirectX.DirectSound
Assembly Microsoft.DirectX.DirectSound (microsoft.directx.directsound.dll)
Strong Name Microsoft.DirectX.DirectSound,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492

See Also