Miles Sound System SDK 7.2a

AIL_sample_channel_levels

The function AIL_sample_channel_levels returns an array of level-scaling factors for one or more combinations of source channels and destination speakers.

void AIL_sample_channel_levels(
  HSAMPLE S,
  MSS_SPEAKER const * source_speaker_indexes,
  MSS_SPEAKER const * dest_speaker_indexes,
  F32 *level_array,
  S32 n_levels
);

In Parameters

S: indicates the HSAMPLE for which the channel levels are to be retrieved.
source_speaker_indexes: specifies an array of one or more channels in the source data.
dest_speaker_indexes: specifies an array of one or more speakers.
n_levels: specifies the number of entries in level_array, source_speaker_indexes, and dest_speaker_indexes.

Out Parameters

level_array: an array of coefficients from 0.0 to 1.0 which will scale the output of the HSAMPLE at each combination of source/destination channels specified by the corresponding source_speaker_indexes and dest_speaker_indexes entries.

Discussion

This function lets you retrieve the per-channel volume scale factors passed to AIL_set_sample_channel_levels by the application or established at sample-initialization time.

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 Xbox 1 and MSS_MC_DIRECTSOUND3D and MSS_MC_EAX? values from the MSS_MC_SPEC list.

For a detailed understanding of per-channel level control, you should carefully review the How do I use multi-channel sound output in Miles? FAQ before attempting to use this function.

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