Miles Sound System SDK 7.2a

AIL_set_digital_master_reverb

The function AIL_set_digital_master_reverb sets the global reverb settings to use.

void AIL_set_digital_master_reverb(
  HDIGDRIVER dig,
  F32 reverb_time,
  F32 reverb_predelay,
  F32 reverb_damping
);

In Parameters

dig: indicates the driver for which the new master reverb settings are to be specified.
reverb_time: specifies the total reverb time from 0.0 to 8.0 seconds.
reverb_predelay: specifies the delay before the reverb will be heard from 0.0 to 0.250 seconds.
reverb_damping: specifies the high frequency damping that should be performed - this is a low-pass filter performed on the samples that are fed to the reverb engine. Specified from 0.0 to 1.0 relative to playback frequency of the sample.

Discussion

The AIL_set_room_type function uses this function to set EAX-compatible room styles.

You need to set a non-zero wet reverb level of any samples that you want to apply global reverb to - use the AIL_set_sample_reverb_levels to do this.

Global reverb is very inexpensive to apply (about 0.25% - one forth of one percent - per sample).

This function is not supported on Xbox, as the hardware reverb system is much more sophisticated and should be programmed directly. See the Xbox docs for details.

This function will have no effect with per-voice hardware drivers that don't support reverb in hardware. Currently, this applies only to the MSS_MC_DIRECTSOUND3D value from the MSS_MC_SPEC list, since the EAX providers handle reverb directly and the software-mixing options emulate EAX.

Group: Digital Audio Services
Related Sections: EAX Compatible Reverb
Related Functions: AIL_digital_master_reverb_levels, AIL_quick_set_reverb_levels, AIL_set_room_type, AIL_set_sample_reverb_levels
Related Basic Types: F32, HDIGDRIVER, MSS_MC_SPEC, void
Related FAQs: How do I set an environmental reverb room style?