Miles Sound System SDK 7.2a

AIL_sample_51_volume_pan

The function AIL_sample_51_volume_pan returns the current sample 5.1 volumes and pan, from 0 to 1.0, resulting from a prior call to AIL_set_sample_51_volume_pan or AIL_set_sample_51_volume_levels.

void AIL_sample_51_volume_pan(
  HSAMPLE S,
  F32 *volume,
  F32 *pan,
  F32 *fb_pan,
  F32 *center_scale,
  F32 *sub_scale
);

In Parameters

S: indicates the sample whose volume is to be retrieved.

Out Parameters

volume: returns a volume level from 0 (minimum) to 1.0 (maximum) in loudness (0.5 is 10 dB down).
pan: returns a power pan level from 0 (hard-left) to 1.0 (hard-right).
fb_pan: returns a front to back power pan level from 0 (front) to 1.0 (back).
center_scale: returns a center channel level from 0 (minimum) to 1.0 (maximum).
sub_scale: returns a subwoofer channel 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 and/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).

See AIL_set_sample_volume_pan for more information.

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