Miles Sound System SDK 7.2a

AIL_speaker_reverb_levels

The function AIL_speaker_reverb_levels returns three arrays describing the wet and dry reverb-response scalars at all speakers, plus the speaker channel identifiers themselves.

S32 AIL_speaker_reverb_levels(
  HDIGDRIVER dig,
  F32 * *wet_array,
  F32 * *dry_array,
  MSS_SPEAKER * *speaker_index_array
);

In Parameters

dig: indicates the driver whose speaker reverb response should be queried.

Out Parameters

wet_array: if not NULL, receives a pointer to an array of coefficients from 0.0 to 1.0 which scale the wet reverb response at each supported output channel, from 0.0 (no wet reverb) to 1.0 (full wet reverb response).
dry_array: if not NULL, receives a pointer to an array of coefficients from 0.0 to 1.0 which scale the dry response at each supported output channel, from 0.0 (no dry level) to 1.0 (full dry level response).
speaker_index_array: if not NULL, receives a pointer to the array of speaker locations supported by the HDIGDRIVER.

Returns

The number of entries in the returned arrays.

Discussion

When the Miles software mixer is in use, the AIL_set_speaker_reverb_levels function may be called to suppress or amplify 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 reverb response scalars are set to 1.0 when the driver is opened.

This function will not return meaningful information 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_set_speaker_reverb_levels
Related Basic Types: F32, HDIGDRIVER, MSS_MC_SPEC, MSS_SPEAKER, S32
Related FAQs: How do I use multi-channel sound output in Miles?