XAUDIO2FX_VOLUMEMETER_LEVELS

Describes parameters for use with the volume meter APO.

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.

The arrays for pPeakLevels and pRMSLevels must be allocated by the application, they are not returned by IXAudio2Voice::GetEffectParameters only filled out by it if they are present. The application is resposable 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.

Requirements

Header: Declared in Xaudio2fx.h.

See Also

XAudio2 Structures, XAudio2CreateVolumeMeter, IXAudio2Voice::SetEffectParameters, How to: Create an Effect Chain, XAPO Overview