FlangerEffect Class (Microsoft.DirectX.DirectSound)
How Do I...?
- Add Effects to a SecondaryBuffer Object
Represents a Microsoft DirectSound effects object used to set and retrieve effect parameters on a SecondaryBuffer object that supports flange.
Definition
Visual Basic Public Class FlangerEffect
Inherits MarshalByRefObject
Implements IDisposableC# public class FlangerEffect : MarshalByRefObject, IDisposable C++ public ref class FlangerEffect : MarshalByRefObject, IDisposable JScript public class FlangerEffect extends MarshalByRefObject implements IDisposable
Members Table
The following table lists the members exposed by the object.
Events
Event Description Disposing Occurs when the Dispose method is called or when the FlangerEffect object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime. Fields
Field Description DelayMax Retrieves the maximum value for the EffectsFlanger.Delay property. DelayMin Retrieves the minimum value for the EffectsFlanger.Delay property. DepthMax Retrieves the maximum value for the EffectsFlanger.Depth property. DepthMin Retrieves the minimum value for the EffectsFlanger.Depth property. FeedbackMax Retrieves the maximum value for the EffectsFlanger.Feedback property. FeedbackMin Retrieves the minimum value for the EffectsFlanger.Feedback property. FrequencyMax Retrieves the maximum value for the EffectsFlanger.Frequency property. FrequencyMin Retrieves the minimum value for the EffectsFlanger.Frequency property. Phase180 Retrieves the value of 180 degrees of phase differential for the EffectsFlanger.Phase property. Phase90 Retrieves the value of 90 degrees of phase differential for the EffectsFlanger.Phase property. PhaseMax Retrieves the maximum value for the EffectsFlanger.Phase property. PhaseMin Retrieves the minimum value for the EffectsFlanger.Phase property. PhaseNeg180 Retrieves the value of negative 180 degrees of phase differential for the EffectsFlanger.Phase property. PhaseNeg90 Retrieves the value of negative 90 degrees of phase differential for the EffectsFlanger.Phase property. PhaseZero Retrieves the value of zero degrees of phase differential for the EffectsFlanger.Phase property. WaveSin Retrieves the value for a sine waveform for the EffectsFlanger.Waveform property. WaveTriangle Retrieves the value for a triangle waveform for the EffectsFlanger.Waveform property. WetDryMixMax Retrieves the maximum value for the EffectsFlanger.WetDryMix property. WetDryMixMin Retrieves the minimum value for the EffectsFlanger.WetDryMix property. Methods
Method Description Dispose Immediately releases the unmanaged resources used by the FlangerEffect object. Equals Returns a value that indicates whether the current instance is equal to a specified object. Finalize Allows the FlangerEffect object to free resources before it is destroyed by the garbage collector. FlangerEffect Initializes a new instance of the FlangerEffect class. This method supports the .NET Framework Infrastructure and is not intended to be used directly in your code. GetHashCode Returns the hash code for the current instance. GetObjectByValue This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code. op_Equality Compares the current instance of a class to another instance to determine whether they are the same. op_Inequality Compares the current instance of a class to another instance to determine whether they are different. raise_Disposing Raises the FlangerEffect.Disposing event when called from within a derived class. Properties
Property Description AllParameters Retrieves or sets flanger parameters of a SecondaryBuffer object. Disposed Gets a value that indicates whether the object is disposed.
Inheritance Hierarchy
FlangerEffect
Remarks
Obtain this object by calling the GetEffects or GetObjectInPath method of a SecondaryBuffer object that is using the effect.
How Do I...?
Add Effects to a SecondaryBuffer Object
This C# example demonstrates how to add effect objects to a SecondaryBuffer object.
[C#] //Create and setup the sound device. Device dev = new Device(); dev.SetCooperativeLevel(this,CooperativeLevel.Normal); //Create and setup the buffer description. BufferDescription buffer_desc = new BufferDescription(); buffer_desc.ControlEffects = true; //this has to be true to use effects. buffer_desc.GlobalFocus = true; //play sound even if application loses focus. //Create and setup the buffer for playing the sound. SecondaryBuffer buffer = new SecondaryBuffer( @"C:\WINDOWS\Media\ding.wav", buffer_desc, dev); //Create an array of effects descriptions, //set the effect objects to echo and chorus and //set it in the buffer. EffectDescription[] effects = new EffectDescription[2]; effects[0].GuidEffectClass = DSoundHelper.StandardEchoGuid; effects[1].GuidEffectClass = DSoundHelper.StandardChorusGuid; buffer.SetEffects(effects); //Play Buffer. buffer.Play(0,BufferPlayFlags.Default);
Class 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