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

SHAPE EQ/Comp コマンドを初期化します。

## Syntax

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

### Parameters

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

初期化する [SHAPE\_FLOWGRAPH\_COMMAND](/reference/audio/shapeflowgraph/structs/shape_flowgraph_command) コマンド。

*contextId*   \
Type: UINT32

このコマンドが参照する EQ/Comp コンテキスト ID (インデックス)。

*inputMixBuffer*   \
Type: UINT32

入力ミックスバッファー ID。

*sidechainMixBuffer*   \
Type: UINT32

サイドチェインミックスバッファー。このパラメーターは外部サイドチェインの場合にのみ使用され、通常のサイドチェインおよび内部サイドチェインでは無視されます。詳細については、[SHAPE\_EQCOMP\_SIDECHAIN\_MODE](/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode) を参照してください。

*outputMixBuffer*   \
Type: UINT32

出力ミックスバッファー ID。

### Return value

Type: HRESULT

関数が成功した場合は `S_OK` を返します。1 つ以上の引数が無効な場合は `E_INVALIDARG` を返します。

## Remarks

コンプレッサーの目的は、信号のダイナミックレンジを制限することです。これは入力レベルを監視し、ダイナミックなゲイン値を生成することで実現されます。このゲイン値は信号の乗数として使用され、現在の入力信号のレベルに応じて信号を適切にスケーリングします。言い換えれば、これは自動音量調整であり、入力信号を継続的に監視して常に自身を調整します。

コンプレッサーは、特定のしきい値を超えた信号にのみ作用します。信号がしきい値未満の場合、信号は変更されずに通過します。しきい値は、EQComp コンテキストデータの一部としてアプリケーションによって設定されます。圧縮または拡張を実行するためのプログラム可能なコントロールがコンテキストに用意されています。

コンプレッサーは比率パラメーターに従ってサウンドデータを変化させます。これは、入力信号がしきい値を超えた場合にどの程度の減衰を行うかを指定します。比率は文字通り、入力レベルと出力レベルの比です。比率 2:1 では、しきい値を超えた入力レベル 2 dB ごとに、しきい値を超えた出力が 1 dB になります。比率 1:1 の場合、コンプレッサーは実質的にオフの状態になります。比率はコンテキストデータの一部としてアプリケーションによって設定されます。

## Requirements

**Header:** shapeflowgraph.h

**Supported platforms:** XBOX One ファミリー本体および XBOX Series 本体

## See also

[ACP の概要](/build/console-features/audio/overviews/acp-overview)

[SHAPE の概要](/build/console-features/audio/overviews/shape-overview)

[shapeflowgraph](/reference/audio/shapeflowgraph/shapeflowgraph_members)


## Related topics

- [ShapeFlowGraph](/ja-jp/reference/audio/shapeflowgraph/shapeflowgraph_members.md)
- [SetShapeEqCompRelease](/ja-jp/reference/audio/shapeeqcompcontext/functions/setshapeeqcomprelease.md)
- [SetShapeEqCompThreshold](/ja-jp/reference/audio/shapeeqcompcontext/functions/setshapeeqcompthreshold.md)
- [SetShapeEqCompGain](/ja-jp/reference/audio/shapeeqcompcontext/functions/setshapeeqcompgain.md)
- [SetShapeEqCompRatio](/ja-jp/reference/audio/shapeeqcompcontext/functions/setshapeeqcompratio.md)