> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetShapeEqCompRatio

> GetShapeEqCompRatio

# GetShapeEqCompRatio

Gets the compression ratio.

## Syntax

```cpp theme={null}
float GetShapeEqCompRatio(  
         const SHAPE_EQCOMP_CONTEXT* context  
)  
```

### Parameters

*context*   \_In\_\
Type: [SHAPE\_EQCOMP\_CONTEXT\*](/reference/audio/shapeeqcompcontext/structs/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](/build/console-features/audio/overviews/shape-overview#ID4ECF) in [Overview of SHAPE](/build/console-features/audio/overviews/shape-overview).

## Requirements

**Header:** shapeeqcompcontext.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members)


## Related topics

- [ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)
- [SetShapeEqCompRatio](/reference/audio/shapeeqcompcontext/functions/setshapeeqcompratio.md)
- [GetShapeEqCompThreshold](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompthreshold.md)
- [GetShapeEqCompGain](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompgain.md)
- [GetShapeEqCompRelease](/reference/audio/shapeeqcompcontext/functions/getshapeeqcomprelease.md)