Miles Sound System SDK 7.2a

EAX_REVERB

The structure EAX_REVERB used to control the environmental reverb filter in the EAX 4 3D provider

struct EAX_REVERB
{
  S32 Slot;
  S32 Volume;
  MILES_ROOM_TYPE Environment;
  F32 EnvironmentSize;
  F32 EnvironmentDiffusion;
  S32 Room;
  S32 RoomHF;
  S32 RoomLF;
  F32 DecayTime;
  F32 DecayHFRatio;
  F32 DecayLFRatio;
  S32 Reflections;
  F32 ReflectionsDelay;
  F32 ReflectionsPanX;
  F32 ReflectionsPanY;
  F32 ReflectionsPanZ;
  S32 Reverb;
  F32 ReverbDelay;
  F32 ReverbPanX;
  F32 ReverbPanY;
  F32 ReverbPanZ;
  F32 EchoTime;
  F32 EchoDepth;
  F32 ModulationTime;
  F32 ModulationDepth;
  F32 AirAbsorptionHF;
  F32 HFReference;
  F32 LFReference;
  F32 RoomRolloffFactor;
  U32 Flags;
};

In Members

Slot: specifies the slot to query or set. Reverb can use slot 0, 2 and/or 3.
Volume: specifies the volume of this slot in standard EAX attenuation units (-10000 to 0 fixed point millibels, default 0.0).
Environment: specifies one of the room type environment constants (default ENVIRONMENT_GENERIC).
EnvironmentSize: specifies environment size in meters (default 7.5).
EnvironmentDiffusion: controls the echo density in the reverberation decay (0.0 to 1.0, default 1.0).
Room: specifies the room effect level (at mid frequencies) in standard EAX attenuation units (-10000 to 0 fixed point millibels, default -1000).
RoomHF: specifies the relative room effect level at high frequencies in standard EAX attenuation units (-10,000 to 0 fixed point millibels, default -100).
RoomLF: specifies the relative room effect level at low frequencies in standard EAX attenuation units (-10,000 to 0 fixed point millibels, default 0).
DecayTime: specifies the reverberation decay time at mid frequencies in seconds (0.1 to 20.0, default 1.49).
DecayHFRatio: specifies the high-frequency to mid-frequency decay time ratio (0.1 to 2.0, default 0.83).
DecayLFRatio: specifies the low-frequency to mid-frequency decay time ratio (0.1 to 2.0, default 1.0).
Reflections: controls the early reflections level relative to room effect in standard EAX attenuation units (-10000 to 0 fixed point millibels, default -2602).
ReflectionsDelay: specifies the initial reflection delay time from direct path to first reflection in seconds (0.0 to 0.3, default 0.007).
ReflectionsPanX: specifies the normalized X coordinate of the early reflections panning vector (default 0.0).
ReflectionsPanY: specifies the normalized Y coordinate of the early reflections panning vector (default 0.0).
ReflectionsPanZ: specifies the normalized Z coordinate of the early reflections panning vector (default 0.0).
Reverb: specifies the late reverberation level relative to room effect in standard EAX attenuation units (-10000 to 2000 fixed point millibels, default 200).
ReverbDelay: specifies the late reverberation delay time relative to initial reflection in seconds (0.0 to 0.1, default 0.011).
ReverbPanX: specifies the normalized X coordinate of the late reverberation panning vector (default 0.0).
ReverbPanY: specifies the normalized Y coordinate of the late reverberation panning vector (default 0.0).
ReverbPanZ: specifies the normalized Z coordinate of the late reverberation panning vector (default 0.0).
EchoTime: specifies the time lag of an echo in the reverberation decay in seconds (0.075 to 0.25, default 0.25).
EchoDepth: specifies a factor controlling the strength of the echo effect (0.0 to 1.0, default: 0.0).
ModulationTime: specifies rate of modulation in seconds (0.04 to 4.0, default: 0.25).
ModulationDepth: specifies a factor controlling the pitch range of the modulation effect (0.0 to 1.0, default: 0.0).
AirAbsorptionHF: specifies the change in level per meter at high frequencies (-100.0 to 0.0, default -5.0).
HFReference: specifies the reference high frequency in hertz (1000.0 to 20000.0, default 5000.0).
LFReference: specifies the reference low frequency in hertz (20.0 to 1000.0, default 250.0).
RoomRolloffFactor: specifies the a DS3D-style rolloff factor but for room effects (0 to 10.0, default 0,0).
Flags: modifies the behavior of properties - you can use one or more of these values:
1 = delay time adjusted by environment size,
2 = reflection level adjusted by environment size,
4 = reflection delay time adjusted by environment size,
8 = reverb level adjusted by environment size,
16 = reverb delay time adjusted by environment size,
64 = echo time adjusted by environment size,
128 = modulation time adjusted by environment size,
32 = limit high-frequency decay time according to air absorption.
Default: 255.

Discussion

See the EAX 4 documentation for technical details on this filter.

Group: Creative EAX 2, 3, and 4 Providers
Related Sections: Creative's EAX 4 Properties
Related Basic Types: F32, MILES_ROOM_TYPE, S32, U32