DSoundHelper.StandardGargleGuid Field (Microsoft.DirectX.DirectSound)

How Do I...?

• Add Effects to a SecondaryBuffer Object

Retrieves the globally unique identifier (GUID) class identifier for the gargle effect.

Definition

Visual Basic	Public Shared StandardGargleGuid As Guid
C#	public static Guid StandardGargleGuid;
C++	public: static Guid StandardGargleGuid;
JScript	public static var StandardGargleGuid : Guid

Field Value

System.Guid
Returns the GUID class identifier for the gargle effect.

This field is read-only. 

Remarks

This GUID is used by the EffectDescription structure to set the gargle effect to a SecondaryBuffer object.

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