Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 3.73 KB

nf-xaudio2-ixaudio2voice-getchannelvolumes.md

File metadata and controls

86 lines (65 loc) · 3.73 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xaudio2.IXAudio2Voice.GetChannelVolumes
IXAudio2Voice::GetChannelVolumes (xaudio2.h)
Returns the volume levels for the voice, per channel.
GetChannelVolumes
GetChannelVolumes method [XAudio2 Audio Mixing APIs]
GetChannelVolumes method [XAudio2 Audio Mixing APIs]
IXAudio2Voice interface
IXAudio2Voice interface [XAudio2 Audio Mixing APIs]
GetChannelVolumes method
IXAudio2Voice.GetChannelVolumes
IXAudio2Voice::GetChannelVolumes
xaudio2.ixaudio2voice_interface_getchannelvolumes
xaudio2/IXAudio2Voice::GetChannelVolumes
xaudio2\ixaudio2voice_interface_getchannelvolumes.htm
xaudio2
M:Microsoft.directx_sdk.ixaudio2voice.IXAudio2Voice.GetChannelVolumes(UINT32,float@)
12/05/2018
GetChannelVolumes, GetChannelVolumes method [XAudio2 Audio Mixing APIs], GetChannelVolumes method [XAudio2 Audio Mixing APIs],IXAudio2Voice interface, IXAudio2Voice interface [XAudio2 Audio Mixing APIs],GetChannelVolumes method, IXAudio2Voice.GetChannelVolumes, IXAudio2Voice::GetChannelVolumes, xaudio2.ixaudio2voice_interface_getchannelvolumes, xaudio2/IXAudio2Voice::GetChannelVolumes
xaudio2.h
Windows
Windows
19H1
IXAudio2Voice::GetChannelVolumes
xaudio2/IXAudio2Voice::GetChannelVolumes
c++
APIRef
kbSyntax
COM
XAudio2.h
IXAudio2Voice.GetChannelVolumes

IXAudio2Voice::GetChannelVolumes

-description

Returns the volume levels for the voice, per channel.

-parameters

-param Channels [in]

Confirms the channel count of the voice.

-param pVolumes [out]

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.

-returns

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)

-see-also

IXAudio2Voice