Export (0) Print
Expand All

Interactive3DLevel2ReverbEffect Class (Microsoft.DirectX.DirectSound)

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 BasicPublic Class Interactive3DLevel2ReverbEffect
    Inherits MarshalByRefObjectLeave Site
    Implements IDisposableLeave Site
C#public class Interactive3DLevel2ReverbEffect : MarshalByRefObjectLeave Site, IDisposableLeave Site
C++public ref class Interactive3DLevel2ReverbEffect : MarshalByRefObjectLeave Site, IDisposableLeave Site
JScriptpublic class Interactive3DLevel2ReverbEffect extends MarshalByRefObjectLeave Site implements IDisposableLeave Site

Members Table

The following table lists the members exposed by the object.

Events

EventDescription
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

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

Methods

MethodDescription
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.
static (Shared in Visual Basic) op_Equality Compares the current instance of a class to another instance to determine whether they are the same.
static (Shared in Visual Basic) 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

PropertyDescription
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

ObjectLeave Site
MarshalByRefObjectLeave Site
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

NamespaceMicrosoft.DirectX.DirectSound
AssemblyMicrosoft.DirectX.DirectSound (microsoft.directx.directsound.dll)
Strong NameMicrosoft.DirectX.DirectSound,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492
Show:
© 2015 Microsoft