Miles Sound System SDK 7.2a

AIL_set_speaker_reverb_levels

The function AIL_set_speaker_reverb_levels sets the global wet and dry reverb-response scalars at one or more speakers.

void AIL_set_speaker_reverb_levels(
  HDIGDRIVER dig,
  F32 * wet_array,
  F32 * dry_array,
  MSS_SPEAKER * speaker_index_array,
  S32 n_levels
);

In Parameters

dig: indicates the driver whose speaker reverb response should be set.
wet_array: if not NULL, specifies an array of coefficients from 0.0 to 1.0 which will scale the wet reverb response at each specified output channel, from 0.0 (no wet reverb) to 1.0 (full wet reverb response).
dry_array: if not NULL, specifies an array of coefficients from 0.0 to 1.0 which will scale the dry response at each specified output channel, from 0.0 (no dry level) to 1.0 (full dry level response).
speaker_index_array: specifies an array of speaker locations for each supplied wet_array/dry_array entry.
n_levels: specifies the number of entries in wet_array, dry_array, and speaker_index_array.

Discussion

When the Miles software mixer is in use, this function may be called to suppress or amplify wet/dry reverb effects on a per-speaker basis. For instance, you could use it to keep reverb out of the surround channels in a 5.1 configuration. By default, all speaker response scalars are set to 1.0 when the driver is opened.

The wet_array and dry_array values are linear scalars, where each doubling of the level value represents a 6-dB change in the wet or dry level for that channel. For instance, a value of 0.5 is 6 dB quieter than a value of 1.0, and 0.25 would be 12 dB quieter than 1.0.

Either the wet_array or dry_array parameters may be set to NULL to leave the corresponding driver-level response scalars intact.

This function will have no effect with per-voice hardware drivers that don't use the Miles software mixer. Currently, this applies only to the MSS_MC_DIRECTSOUND3D and MSS_MC_EAX? values from the MSS_MC_SPEC list.

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

For a detailed understanding of channel-based control functions such as this one, you should carefully review the How do I use multi-channel sound output in Miles? FAQ.

Group: Digital Audio Services
Related Functions: AIL_speaker_reverb_levels
Related Basic Types: F32, HDIGDRIVER, MSS_MC_SPEC, MSS_SPEAKER, S32, void
Related FAQs: How do I use multi-channel sound output in Miles?