Miles Sound System SDK 7.2a

AIL_sample_51_volume_levels

The function AIL_sample_51_volume_levels returns the current sample 5.1 volumes, from 0 to 1.0, on discrete multichannel platforms.

void AIL_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 retrieved.

Out Parameters

front_left_level: returns the front left speaker volume level from 0 (minimum) to 1.0 (maximum).
front_right_level: returns the front right speaker volume level from 0 (minimum) to 1.0 (maximum).
back_left_level: returns the back left speaker volume level from 0 (minimum) to 1.0 (maximum).
back_right_level: returns the back right speaker volume level from 0 (minimum) to 1.0 (maximum).
center_level: returns the center speaker volume level from 0 (minimum) to 1.0 (maximum).
sub_level: returns 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 dedicated 5.1-channel applications, notably on the Xbox and Xbox 360 platforms (which are always treated as 5.1-channel platforms by Miles).

Group: Digital Audio Services
Related Functions: AIL_sample_reverb_levels, AIL_set_sample_51_volume_levels, AIL_set_sample_channel_levels
Related Basic Types: F32, HSAMPLE, void