SetShapeEqCompRatio

Sets the compression ratio.

Syntax

HRESULT SetShapeEqCompRatio(  
         SHAPE_EQCOMP_CONTEXT* context,  
         float ratio  
)  

Parameters

context _Inout_
Type: SHAPE_EQCOMP_CONTEXT* Pointer to a SHAPE_EQCOMP_CONTEXT object. ratio
Type: float The compression ratio.

Return value

Type: HRESULT HRESULT success or error code.

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

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

SetShapeEqCompRatio

SetShapeEqCompRatio

Syntax

Parameters

Return value

Remarks

Requirements

See also

​SetShapeEqCompRatio

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

SetShapeEqCompRatio

Syntax

Parameters

Return value

Remarks

Requirements

See also