EffectsChorus Structure (Microsoft.DirectX.DirectSound)

How Do I...?

  • Use Effect Parameters

Contains parameters for a chorus effect.


Visual Basic Public Structure EffectsChorus
C# public struct EffectsChorus 
C++ public value class EffectsChorus 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.


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


Property Description
Delay Retrieves and sets the number of milliseconds the input is delayed before it is played back, in the EffectsChorus structure.
Depth Retrieves and sets the percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point, in the EffectsChorus structure.
Feedback Retrieves and sets the percentage of output signal to feed back into the effect's input, in the EffectsChorus structure.
Frequency Retrieves and sets the frequency of the LFO, in the EffectsChorus structure.
Phase Retrieves and sets the phase differential between left and right LFOs, in the EffectsChorus structure.
Waveform Retrieves and sets the waveform shape of the LFO, in the EffectsChorus structure.
WetDryMix Retrieves and sets the ratio of wet (processed) signal to dry (unprocessed) signal, in the EffectsChorus 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.


//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;

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