Skip to main content

​
GetShapeEqCompGainReduction

Gets the output gain reduction of the compressor.

​
Syntax

​
Parameters

context   _In_
Type: SHAPE_EQCOMP_CONTEXT* Pointer to a SHAPE_EQCOMP_CONTEXT object.

​
Return value

Type: float The gain reduction multiplier.

​
Remarks

The compressor limits the dynamic range of the signal by monitoring the level of input and creating a dynamic gain value. The compressor then uses the gain value as a multiplier of the signal, scaling it appropriately, according to the current level of the input signal. In other words, the compressor is an automatic volume control that is constantly monitoring the input signal and adjusting itself. For more information, see Equalization and compression in Overview of SHAPE.

​
Requirements

Header: shapeeqcompcontext.h Supported platforms: XBOX One family consoles and XBOX Series consoles

​
See also

ShapeEqCompContext
Last modified on August 20, 2026

Related topics

ShapeEqCompContextGetShapeEqCompGainGetShapeEqCompGainTargetGetShapeEqCompLogGainSetShapeEqCompGain