> ## 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.

# SetShapeEqCompCommand

> SetShapeEqCompCommand

# SetShapeEqCompCommand

Initialise une commande EQ/Comp SHAPE.

## Syntaxe

```cpp theme={null}
HRESULT SetShapeEqCompCommand(  
         SHAPE_FLOWGRAPH_COMMAND* command,  
         UINT32 contextId,  
         UINT32 inputMixBuffer,  
         UINT32 sidechainMixBuffer,  
         UINT32 outputMixBuffer  
)  
```

### Paramètres

*command*   \_Inout\_\
Type : SHAPE\_FLOWGRAPH\_COMMAND\*

La commande [SHAPE\_FLOWGRAPH\_COMMAND](/fr-CA/reference/audio/shapeflowgraph/structs/shape_flowgraph_command) à initialiser.

*contextId*   \
Type : UINT32

ID (index) du contexte EQ/Comp auquel cette commande fera référence.

*inputMixBuffer*   \
Type : UINT32

ID du tampon de mixage d'entrée.

*sidechainMixBuffer*   \
Type : UINT32

Tampon de mixage de chaîne latérale. Ce paramètre est utilisé uniquement pour les chaînes latérales externes et est ignoré pour les chaînes latérales normales et internes. Pour plus d'information, consultez [SHAPE\_EQCOMP\_SIDECHAIN\_MODE](/fr-CA/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode).

*outputMixBuffer*   \
Type : UINT32

ID du tampon de mixage de sortie.

### Valeur de retour

Type : HRESULT

Si la fonction réussit, elle retourne `S_OK`. Si un ou plusieurs arguments ne sont pas valides, la fonction retourne `E_INVALIDARG`.

## Remarques

Le but du compresseur est de limiter la plage dynamique du signal. Pour ce faire, il surveille le niveau d'entrée et crée une valeur de gain dynamique. La valeur de gain est ensuite utilisée comme multiplicateur du signal et le met à l'échelle de manière appropriée selon le niveau actuel du signal d'entrée. Autrement dit, il s'agit d'un contrôle automatique du volume, qui surveille constamment le signal d'entrée et s'ajuste constamment.

Le compresseur agit uniquement sur les signaux supérieurs à un seuil précis. Si le signal est inférieur au seuil, il passe sans être modifié. Le seuil est défini par l'application dans les données du contexte EQComp. Le contexte comporte un contrôle programmable permettant d'effectuer une compression ou une expansion.

Le compresseur modifie les données sonores selon un paramètre de ratio. Celui-ci spécifie l'atténuation à appliquer au signal entrant s'il dépasse le seuil. Le ratio est exactement cela : le rapport entre le niveau entrant et le niveau sortant. Avec un ratio de 2:1, chaque tranche de 2 dB au-dessus du seuil produit 1 dB en sortie du compresseur au-dessus du niveau du seuil. Avec un ratio de 1:1, le compresseur est pratiquement désactivé. Le ratio est défini par l'application dans les données du contexte.

## Configuration requise

**En-tête :** shapeflowgraph.h

**Plateformes prises en charge :** consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[Vue d'ensemble de l'ACP](/fr-CA/build/console-features/audio/overviews/acp-overview)

[Vue d'ensemble de SHAPE](/fr-CA/build/console-features/audio/overviews/shape-overview)

[shapeflowgraph](/fr-CA/reference/audio/shapeflowgraph/shapeflowgraph_members)


## Related topics

- [SetShapeEqCompCommand](/ko/reference/audio/shapeflowgraph/functions/setshapeeqcompcommand.md)
- [ShapeFlowGraph](/reference/audio/shapeflowgraph/shapeflowgraph_members.md)