Skip to main content

SetShapeEqCompSidechainMode

Sets the sidechain mode.

Syntax

Parameters

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

Return value

Type: HRESULT HRESULT success or error code.

Remarks

The EQ/Compressor-Expander block takes input from one or two mix buffers:
  • One input is the audio signal to be processed.
  • The second input, called sidechain, is the optional control signal used to determine the audio compression.
The Compressor-Expander can be operated in one of three sidechain modes:
  • In Normal mode, a single audio input from a mix buffer is fed through the equalizer, where it’s subsequently processed by the compressor and output to a mix buffer.
  • In Internal mode, the input signal is fed directly into the audio input of the compressor, and it’s split and sent to the equalizer. From the equalizer, it’s sent to the sidechain input of the compressor.
  • In External mode, two separate input signals are used from two separate mix buffers. The input signal is fed through the equalizer and into the audio input of the compression block. The sidechain input signal is fed directly into the sidechain input of the compressor.
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

GetShapeEqCompSidechainMode
ShapeEqCompContext
Last modified on August 20, 2026