GetShapeEqCompExpandMode
Gets the compression/expansion mode.Syntax
Parameters
context _In_Type: SHAPE_EQCOMP_CONTEXT* Pointer to a
SHAPE_EQCOMP_CONTEXT object.
Return value
Type: SHAPE_EQCOMP_EXPAND_MODE A member of theSHAPE_EQCOMP_EXPAND_MODE enumeration.
Remarks
Typically, the EQ/Compressor-Expander block limits the dynamic range of the signal. The compressor acts only on signals that exceed a specific threshold; signals under the threshold pass through unaltered. If the return value of this function isSHAPE_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
SetShapeEqCompExpandModeGetShapeEqCompThreshold
ShapeEqCompContext