SetShapeEqCompEnableCompressor

Sets the state of the compressor flag.

Syntax

HRESULT SetShapeEqCompEnableCompressor(  
         SHAPE_EQCOMP_CONTEXT* context,  
         bool enable  
)  

Parameters

context _Inout_
Type: SHAPE_EQCOMP_CONTEXT* Pointer to a SHAPE_EQCOMP_CONTEXT object. enable
Type: bool True to enable the compressor portion of the equalizer/compressor-expander block.

Return value

Type: HRESULT HRESULT success or error code.

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 according to the current level of the input signal. In other words, the compressor is an automatic volume control that constantly monitors the input signal and adjusts 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

(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

SetShapeEqCompEnableCompressor

SetShapeEqCompEnableCompressor

Syntax

Parameters

Return value

Remarks

Requirements

See also

​SetShapeEqCompEnableCompressor

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

SetShapeEqCompEnableCompressor

Syntax

Parameters

Return value

Remarks

Requirements

See also