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

# XApuCommandId

> XApuCommandId

# XApuCommandId

定义要发送到 XAPU 或从 XAPU 接收的基本命令参数。所有其他命令都从此类型扩展而来。

## Syntax

```cpp theme={null}
typedef struct XApuCommandId {  
    XApuCommandType type;  
    uint32_t streamIndex;  
    uint32_t sequence;  
    XApuCommandOptions options;  
    void* context;  
} XApuCommandId  
```

### Members

*type*\
Type: [XApuCommandType](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandtype.md)

指示硬件如何处理此命令中关联数据的命令类型。

*streamIndex*\
Type: uint32\_t

流的索引。该值应介于 0 和 [XApuConnectInputParameters::maxStreamCount](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapuconnectinputparameters.md) - 1 之间。每个流都应有唯一的索引值,由调用方负责分配此值。

*sequence*\
Type: uint32\_t

XAPU 不会修改此值,如何使用它由调用方决定。它可以用作命令序列号,该序列号会随时间递增,以便在数据包从结果队列中出来时对其进行跟踪。XAPU 不会根据此序列号重新排列数据包顺序,如果此数字倒退或与前一值之间存在间隔,XAPU 也不会返回错误。

*options*\
Type: [XApuCommandOptions](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandoptions.md)

命令选项。某些选项可以应用于所有命令类型,如 [XApuCommandOptions::SignalOnCompletion](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandoptions.md);另一些选项仅适用于特定命令类型,如 [XApuCommandOptions::Flush](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandoptions.md) 和 [XApuCommandOptions::Decoder](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandoptions.md)。

*context*\
Type: void\*

一个可选的占位符,用于存放用户数据,XAPU 将从入队命令阶段一直到出队结果阶段在内部按原样传递这些数据。调用方可以自由传递任何能够容纳在 64 位无符号值中的数据,例如时间戳。

## Remarks

[XApuCommandId](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapucommandid.md) 使用它来定义要发送到 XAPU 或从 XAPU 接收的基本命令参数。所有其他命令都从此类型扩展而来。有关解码和转换激活处理参数的详细信息,请参阅 [XApuDecodeConvertActivateCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md) 和 [XApuDecodeConvertCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapudecodeconvertcommand.md)。有关向 XAPU 输入队列提交命令的信息,请参阅 [XApuEnqueueCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuenqueuecommand.md)。

## Requirements

**头文件:** xapu.h

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

## See also

[XApuDequeueResult](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapudequeueresult.md)\
[XApuResult](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapuresult.md)\
[XAPU](https://docs.xbox.com/zh-CN/reference/audio/xapu/xapu_members.md)


## Related topics

- [XApuCommandType](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandtype.md)
- [XApuCommandOptions](https://docs.xbox.com/zh-CN/reference/audio/xapu/enums/xapucommandoptions.md)
- [XApuDecodeConvertActivateCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md)
- [XApuEnqueueCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/functions/xapuenqueuecommand.md)
- [XApuDecodeConvertCommand](https://docs.xbox.com/zh-CN/reference/audio/xapu/structs/xapudecodeconvertcommand.md)