XAUDIO2FX_VOLUMEMETER_LEVELS structure (xaudio2fx.h)

Article
02/22/2024

Describes parameters for use with the volume meter APO.

Syntax

typedef struct XAUDIO2FX_VOLUMEMETER_LEVELS {
  float  *pPeakLevels;
  float  *pRMSLevels;
  UINT32 ChannelCount;
} XAUDIO2FX_VOLUMEMETER_LEVELS;

Members

pPeakLevels

Array that will be filled with the maximum absolute level for each channel during a processing pass. The array must be at least ChannelCount × sizeof(float) bytes. pPeakLevels may be NULL if pRMSLevels is not NULL.

pRMSLevels

Array that will be filled with root mean square level for each channel during a processing pass. The array must be at least ChannelCount × sizeof(float) bytes. pRMSLevels may be NULL if pPeakLevels is not NULL.

ChannelCount

Number of channels being processed.

Remarks

This structure is used with the XAudio2 IXAudio2Voice::GetEffectParameters method.

pPeakLevels and pRMSLevels are not returned by IXAudio2Voice::GetEffectParameters, the arrays are only filled out if they are present. If pPeakLevels and pRMSLevels are used they must be allocated by the application. The application is responsible for freeing the arrays when they are no longer needed.

ChannelCount must be set by the application to match the number of channels in the voice the effect is applied to.

Platform Requirements

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

Requirements

Requirement	Value
Header	xaudio2fx.h