Interactive3DLevel2ReverbEffect 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 Interactive 3-D Audio Level 2 (I3DL2) reverberation effects.

Definition

Visual Basic	Public Class Interactive3DLevel2ReverbEffect     Inherits MarshalByRefObject     Implements IDisposable
C#	public class Interactive3DLevel2ReverbEffect : MarshalByRefObject, IDisposable
C++	public ref class Interactive3DLevel2ReverbEffect : MarshalByRefObject, IDisposable
JScript	public class Interactive3DLevel2ReverbEffect 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 Interactive3DLevel2ReverbEffect object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Fields

Field	Description
DecayHfRatioDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.DecayHfRatio property.
DecayHfRatioMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.DecayHfRatio property.
DecayHfRatioMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.DecayHfRatio property.
DecayTimeDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.DecayTime property.
DecayTimeMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.DecayTime property.
DecayTimeMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.DecayTime property.
DensityDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.Density property.
DensityMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.Density property.
DensityMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.Density property.
DiffusionDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.Diffusion property.
DiffusionMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.Diffusion property.
DiffusionMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.Diffusion property.
HfReferenceDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.HfReference property.
HfReferenceMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.HfReference property.
HfReferenceMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.HfReference property.
QualityDefault	Retrieves the default value for the Interactive3DLevel2ReverbEffect.Quality property.
QualityMax	Retrieves the maximum value for the Interactive3DLevel2ReverbEffect.Quality property.
QualityMin	Retrieves the minimum value for the Interactive3DLevel2ReverbEffect.Quality property.
ReflectionsDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.Reflections property.
ReflectionsDelayDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.ReflectionsDelay property.
ReflectionsDelayMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.ReflectionsDelay property.
ReflectionsDelayMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.ReflectionsDelay property.
ReflectionsMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.Reflections property.
ReflectionsMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.Reflections property.
ReverbDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.Reverb property.
ReverbDelayDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.ReverbDelay property.
ReverbDelayMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.ReverbDelay property.
ReverbDelayMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.ReverbDelay property.
ReverbMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.Reverb property.
ReverbMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.Reverb property.
RoomDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.Room property.
RoomHfDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.RoomHf property.
RoomHfMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.RoomHf property.
RoomHfMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.RoomHf property.
RoomMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.Room property.
RoomMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.Room property.
RoomRollOffFactorDefault	Retrieves the default value for the EffectsInteractive3DLevel2Reverb.RoomRollOffFactor property.
RoomRollOffFactorMax	Retrieves the maximum value for the EffectsInteractive3DLevel2Reverb.RoomRollOffFactor property.
RoomRollOffFactorMin	Retrieves the minimum value for the EffectsInteractive3DLevel2Reverb.RoomRollOffFactor property.

Methods

Method	Description
Dispose	Immediately releases the unmanaged resources used by the Interactive3DLevel2ReverbEffect object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the Interactive3DLevel2ReverbEffect object to free resources before it is destroyed by the garbage collector.
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.
Interactive3DLevel2ReverbEffect	Initializes a new instance of the Interactive3DLevel2ReverbEffect class. This method supports the .NET Framework Infrastructure and is not intended to be used directly in 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 Interactive3DLevel2ReverbEffect.Disposing event when called from within a derived class.

Properties

Property	Description
AllParameters	Retrieves or sets interactive 3-D level 2 (I3DL2) environmental reverberation parameters of a SecondaryBuffer object.
Disposed	Gets a value that indicates whether the object is disposed.
Preset	Retrieves or sets a standard reverberation parameters of a SecondaryBuffer object.
Quality	Retrieves or sets the quality of the environmental reverberation effect.

Inheritance Hierarchy

Object

MarshalByRefObject

Interactive3DLevel2ReverbEffect

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