SetShapeEqCompThreshold
Sets the compression threshold.Syntax
Parameters
context _Inout_Type: SHAPE_EQCOMP_CONTEXT* Pointer to a
SHAPE_EQCOMP_CONTEXT object.
threshold Type: float The compression threshold value.
Return value
Type: HRESULT HRESULT success or error code.Remarks
The compressor acts only on signals that exceed a specific threshold; signals under the threshold pass through unaltered. The compressor alters the sound data according to a parameter that specifies the ratio of incoming level to outgoing level. The ratio represents the extent of attenuation to be performed on the incoming signal if it exceeds the threshold. (If the compressor/expander mode is set toSHAPE_EQCOMP_EXPAND_MODE_EXPANDER, the behavior is reversed. The expander acts on signals below a specific threshold; signals above the threshold pass through unaltered.)
For more information, see Equalization and compression in Overview of SHAPE.
Requirements
Header: shapeeqcompcontext.h Supported platforms: XBOX One family consoles and XBOX Series consolesSee also
GetShapeEqCompThresholdShapeEqCompContext