Miles Sound System SDK 7.2a

AIL_set_sample_51_volume_levels

The function AIL_set_sample_51_volume_levels controls a sample's playback volume levels when using multichannel discrete output modes.

void AIL_set_sample_51_volume_levels(
  HSAMPLE S,
  F32 front_left_level,
  F32 front_right_level,
  F32 back_left_level,
  F32 back_right_level,
  F32 center_level,
  F32 sub_level
);

In Parameters

S: indicates the sample whose volume is to be set.
front_left_level: is the left speaker volume level from 0 (minimum) to 1.0 (maximum).
front_right_level: is the right speaker volume level from 0 (minimum) to 1.0 (maximum).
back_left_level: is the left speaker volume level from 0 (minimum) to 1.0 (maximum).
back_right_level: is the right speaker volume level from 0 (minimum) to 1.0 (maximum).
center_level: is the center speaker volume level from 0 (minimum) to 1.0 (maximum).
sub_level: is the subwoofer speaker volume level from 0 (minimum) to 1.0 (maximum).

Discussion

This function is available on all software-mixed platforms, as well as on the Xbox. Parameters that don't correspond to an available speaker in the HDIGDRIVER's current mode will be ignored.

Levels calculated by this function are multiplied with any values arising from 3D positioning or the use of the AIL_set_sample_channel_levels function. This function is intended primarily for use as a "shortcut" for multichannel applications, notably on the Xbox and Xbox 360 platforms (which are always treated as 5.1-channel platforms by Miles). This volume setting is linear in amplitude - using 0.5 is equivalent to 6 dB down. Use AIL_set_sample_51_volume_pan to set volumes linear in loudness.

All sample volume-scaling occurs at full sample precision.

Group: Digital Audio Services
Related Sections: Sound under Xbox, Sound under Xbox 360
Related Functions: AIL_sample_51_volume_levels, AIL_sample_51_volume_pan, AIL_set_sample_51_volume_pan, AIL_set_sample_channel_levels, AIL_set_sample_reverb_levels
Related Basic Types: F32, HSAMPLE, void