IXAudio2Voice::GetChannelVolumes method (xaudio2.h)

Article
02/22/2024

Returns the volume levels for the voice, per channel.

Syntax

\\ void GetChannelVolumes(
  [in]  UINT32 Channels,
  [out] float  *pVolumes
);

Parameters

[in] Channels

Confirms the channel count of the voice.

[out] pVolumes

Returns the current volume level of each channel in the voice. The array must have at least Channels elements. See Remarks for more information on volume levels.

Return value

This method does not return a value.

Remarks

These settings are applied after the effect chain is applied. This method is valid only for source and submix voices, because mastering voices do not specify volume per channel.

Volume levels are expressed as floating-point amplitude multipliers between -2²⁴ to 2²⁴, with a maximum gain of 144.5 dB. A volume of 1 means there is no attenuation or gain, 0 means silence, and negative levels can be used to invert the audio's phase. See XAudio2 Volume and Pitch Control for additional information on volume control.

Note GetChannelVolumes always returns the volume levels most recently set by IXAudio2Voice::SetChannelVolumes. However, those values may not actually be in effect yet: they only take effect the next time the audio engine runs after the IXAudio2Voice::SetChannelVolumes call (or after the corresponding IXAudio2::CommitChanges call, if IXAudio2Voice::SetChannelVolumes was called with a deferred operation ID).

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement	Value
Target Platform	Windows
Header	xaudio2.h