Skip to main content

SetShapeEqCompCompressorMode

Sets the compression mode.

Syntax

Parameters

context   _Inout_
Type: SHAPE_EQCOMP_CONTEXT*
Pointer to a SHAPE_EQCOMP_CONTEXT object. mode   
Type: SHAPE_EQCOMP_COMPRESSOR_MODE
A member of the SHAPE_EQCOMP_COMPRESSOR_MODE enumeration.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

In normal mode, the input level is instantaneous, with compression calculated for each sample. In RMS mode, a running average, representing an approximation of the RMS value, of the previous 128 samples is used as the input level, rather than the absolute level of the current input sample. (The running average is an approximation of the RMS value.) 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

GetShapeEqCompCompressorMode
ShapeEqCompContext
Last modified on August 20, 2026