> ## 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 命令。

## 语法

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

### 参数

*command*   \_Inout\_\
类型:SHAPE\_FLOWGRAPH\_COMMAND\*

要初始化的 [SHAPE\_FLOWGRAPH\_COMMAND](/reference/audio/shapeflowgraph/structs/shape_flowgraph_command) 命令。

*contextId*   \
类型:UINT32

此命令将引用的 EQ/Comp 上下文 ID(索引)。

*inputMixBuffer*   \
类型:UINT32

输入混音缓冲区 ID。

*sidechainMixBuffer*   \
类型:UINT32

侧链混音缓冲区。此参数仅用于外部侧链,对于普通和内部侧链会被忽略。有关详细信息,请参阅 [SHAPE\_EQCOMP\_SIDECHAIN\_MODE](/reference/audio/shapeeqcompcontext/enums/shape_eqcomp_sidechain_mode)。

*outputMixBuffer*   \
类型:UINT32

输出混音缓冲区 ID。

### 返回值

类型:HRESULT

如果函数成功,则返回 `S_OK`。如果一个或多个参数无效,函数返回 `E_INVALIDARG`。

## 注解

压缩器的用途是限制信号中的动态范围。它通过监控输入电平并生成动态增益值来实现这一点。然后将该增益值用作信号的乘数,根据当前输入信号的电平对信号进行相应缩放。换句话说,它是一个自动音量控制器,不断监控输入信号并不断进行自我调整。

压缩器只对高于特定阈值的信号起作用。如果信号低于阈值,则信号不经改变直接通过。阈值由应用程序作为 EQComp 上下文数据的一部分进行设置。上下文中提供了可编程控制,用于执行压缩或扩展。

压缩器根据一个比率参数改变声音数据。该参数指定当输入信号超过阈值时应对其进行的衰减量。这个比率就是字面意义上的比率:输入电平与输出电平的比值。在 2:1 的比率下,每 2 dB 超过阈值的电平将导致压缩器输出的电平比阈值高 1 dB。当比率为 1:1 时,压缩器基本上处于关闭状态。比率由应用程序作为上下文数据的一部分进行设置。

## 要求

**头文件:** shapeflowgraph.h

**支持的平台:** XBOX One 系列主机和 XBOX Series 主机

## 另请参阅

[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](/zh-CN/reference/audio/shapeflowgraph/shapeflowgraph_members.md)
- [SetShapeEqCompRelease](/zh-CN/reference/audio/shapeeqcompcontext/functions/setshapeeqcomprelease.md)
- [SetShapeEqCompThreshold](/zh-CN/reference/audio/shapeeqcompcontext/functions/setshapeeqcompthreshold.md)
- [SetShapeEqCompAttack](/zh-CN/reference/audio/shapeeqcompcontext/functions/setshapeeqcompattack.md)
- [SetShapeEqCompGain](/zh-CN/reference/audio/shapeeqcompcontext/functions/setshapeeqcompgain.md)