Skip to main content

​
GetShapeEqCompRatio

Gets the compression ratio.

​
Syntax

​
Parameters

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

​
Return value

Type: float The compression ratio.

​
Remarks

The compressor alters the sound data according to the ratio of incoming level to outgoing level. The ratio determines how much attenuation should be done on the incoming signal when it exceeds the threshold. For example, at a ratio of 2:1, every 2 dB of level over the threshold results in 1 dB output from the compressor over the threshold level. With a ratio of 1:1, the compressor is essentially off. 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

ShapeEqCompContextSetShapeEqCompRatioGetShapeEqCompThresholdGetShapeEqCompGainGetShapeEqCompRelease