> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetShapeEqCompSidechainMode

> GetShapeEqCompSidechainMode

# GetShapeEqCompSidechainMode

Gets the sidechain mode.

## Syntax

```cpp theme={null}
SHAPE_EQCOMP_SIDECHAIN_MODE GetShapeEqCompSidechainMode(  
         const SHAPE_EQCOMP_CONTEXT* context  
)  
```

### Parameters

*context*   \_In\_\
Type: [SHAPE\_EQCOMP\_CONTEXT\*](/reference/audio/shapeeqcompcontext/structs/shape_eqcomp_context)

Pointer to a `SHAPE_EQCOMP_CONTEXT` object.

### Return value

Type: [SHAPE\_EQCOMP\_SIDECHAIN\_MODE](/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode)

A member of the `SHAPE_EQCOMP_SIDECHAIN_MODE` enumeration.

## 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](/build/console-features/audio/overviews/shape-overview#ID4ECF) in [Overview of SHAPE](/build/console-features/audio/overviews/shape-overview).

## Requirements

**Header:** shapeeqcompcontext.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[SetShapeEqCompSidechainMode](/reference/audio/shapeeqcompcontext/functions/setshapeeqcompsidechainmode)\
[ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members)


## Related topics

- [SetShapeEqCompSidechainMode](/reference/audio/shapeeqcompcontext/functions/setshapeeqcompsidechainmode.md)
- [SHAPE_EQCOMP_SIDECHAIN_MODE](/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode.md)
- [ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)
- [GetShapeEqCompCompressorMode](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompcompressormode.md)
- [GetShapeEqCompExpandMode](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompexpandmode.md)