GargleEffect Class

Language: Visual BasicC#C++JScript(Show All)

---

Represents a Microsoft DirectSound effects object used to set and retrieve effect parameters on a SecondaryBuffer object that supports amplitude modulation.

Definition

Visual Basic	Public Class GargleEffect     Inherits MarshalByRefObject     Implements IDisposable
C#	public class GargleEffect : MarshalByRefObject, IDisposable
C++	public ref class GargleEffect : MarshalByRefObject, IDisposable
JScript	public class GargleEffect extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Events

Event	Description
Disposing	Occurs when the Dispose method is called or when the GargleEffect object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Fields

Field	Description
RateHzMax	Retrieves the maximum value for the EffectsGargle.RateHz property.
RateHzMin	Retrieves the minimum value for the EffectsGargle.RateHz property.
WaveSquare	Retrieves the value for a square modulation waveform for the EffectsGargle.WaveShape property.
WaveTriangle	Retrieves the value for a triangle modulation waveform for the EffectsGargle.WaveShape property.

Methods

Method	Description
Dispose	Immediately releases the unmanaged resources used by the GargleEffect object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the GargleEffect object to free resources before it is destroyed by the garbage collector.
GargleEffect	Initializes a new instance of the GargleEffect 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 GargleEffect.Disposing event when called from within a derived class.

Properties

Property	Description
AllParameters	Retrieves or sets gargle parameters of a SecondaryBuffer object.
Disposed	Gets a value that indicates whether the object is disposed.

Inheritance Hierarchy

Object

MarshalByRefObject

GargleEffect

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

---

Send comments about this topic to Microsoft. © Microsoft Corporation. All rights reserved.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center