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

# XApuCommandOptions

> XApuCommandOptions

# XApuCommandOptions

为不同命令类型定义选项。

## Syntax

```cpp theme={null}
enum class XApuCommandOptions  : uint32_t  
{  
    None = 0,  
    SignalOnCompletion = 1,  
    Flush = 2,  
    Decoder = 4,  
}  
```

## Constants

| 常量                 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| None               | 未设置任何选项。                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SignalOnCompletion | 此标志可应用于所有命令类型;设置后,当命令的结果就绪时,会发出 [XApuConnectOutputParameters::resultReadyEvent](/reference/audio/xapu/structs/xapuconnectoutputparameters) 信号。若要使用此标志,调用方必须在 [XApuConnect](/reference/audio/xapu/functions/xapuconnect) 中设置 [XApuConnectOptions::EnableResultReadyEvent](/reference/audio/xapu/enums/xapuconnectoptions)。请参阅 [XApuConnectOutputParameters::resultReadyEvent](/reference/audio/xapu/structs/xapuconnectoutputparameters) 的说明。 |
| Flush              | 在有可用输出数据时释放输出数据,而不等待更多输入数据。此标志仅与 [XApuProcessType::Process](/reference/audio/xapu/enums/xapuprocesstype) 配合使用,否则将被忽略。此标志只能与 [XApuProcessType::DecodeConvertOpus](/reference/audio/xapu/enums/xapuprocesstype) 和 [XApuProcessType::ConvertPCM](/reference/audio/xapu/enums/xapuprocesstype) 一起使用。                                                                                                                                             |
| Decoder            | 设置后,仅在 [XApuProcessType::DecodeConvertOpus](/reference/audio/xapu/enums/xapuprocesstype) 处理模式中重置解码器。此标志仅与 [XApuCommandType::Reset](/reference/audio/xapu/enums/xapucommandtype) 配合使用,否则将被忽略。此标志可用于仅在解码转换场景中查找时重置解码器。在查找、循环或拼接两个流时是否将 [XApuCommandType::Reset](/reference/audio/xapu/enums/xapucommandtype) 与 [XApuCommandOptions::Decoder](/reference/audio/xapu/enums/xapucommandoptions) 标志一起使用由调用方决定,但在使用时,调用方必须提交预滚数据以避免输出中的瞬态效应。        |

## Remarks

此枚举使用 [XApuConnectOutputParameters::resultReadyEvent](/reference/audio/xapu/structs/xapuconnectoutputparameters) 方法在命令结果就绪时发出信号。解码器命令仅使用 [XApuProcessType::DecodeConvertOpus](/reference/audio/xapu/enums/xapuprocesstype) 方法。否则,将使用 [XApuCommandType::Reset](/reference/audio/xapu/enums/xapucommandtype) 方法重置 Opus 解码器。

当 Decoder 标志与 Reset 命令一起使用时,它不会擦除已解码但仍在等待处理进入 HSRC 的数据。

## Requirements

**头文件:** xapu.h

**支持的平台:** XBOX Series X|S

## See also

[XApuCommandId](/reference/audio/xapu/structs/xapucommandid)\
[XApuConnectOutputParameters](/reference/audio/xapu/structs/xapuconnectoutputparameters)\
[XAPU](/reference/audio/xapu/xapu_members)


## Related topics

- [XApuCommandId](/zh-CN/reference/audio/xapu/structs/xapucommandid.md)
- [XApuConnectOutputParameters](/zh-CN/reference/audio/xapu/structs/xapuconnectoutputparameters.md)
- [XAPU](/zh-CN/reference/audio/xapu/xapu_members.md)
- [XApuDecodeConvertActivateCommand](/zh-CN/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md)
- [XAPU 概述](/zh-CN/build/console-features/audio/overviews/xapu-overview.md)
