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

# XApuCommandId

> XApuCommandId

# XApuCommandId

定義要傳送至 XAPU 及從 XAPU 接收的基本命令參數。所有其他命令都是從此類型擴充而來。

## 語法

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

### 成員

*type*\
類型：[XApuCommandType](/zh-TW/reference/audio/xapu/enums/xapucommandtype)

命令類型，用來指示硬體如何處理此命令中的相關資料。

*streamIndex*\
類型：uint32\_t

串流的索引。此值應介於 0 與 [XApuConnectInputParameters::maxStreamCount](/zh-TW/reference/audio/xapu/structs/xapuconnectinputparameters) - 1 之間。每個串流都應有唯一的索引值，且由呼叫端負責指派此值。

*sequence*\
類型：uint32\_t

XAPU 不會變更此值，如何使用由呼叫端決定。它可以用作隨時間遞增的命令序號，以便在封包從結果佇列輸出時加以追蹤。XAPU 不會依據此序號重新排列封包的順序，若此數字倒退或與先前的值之間有間隔，也不會傳回錯誤。

*options*\
類型：[XApuCommandOptions](/zh-TW/reference/audio/xapu/enums/xapucommandoptions)

命令選項。有些選項可套用至所有命令類型，例如 [XApuCommandOptions::SignalOnCompletion](/zh-TW/reference/audio/xapu/enums/xapucommandoptions)，其他選項則適用於特定命令類型，例如 [XApuCommandOptions::Flush](/zh-TW/reference/audio/xapu/enums/xapucommandoptions) 和 [XApuCommandOptions::Decoder](/zh-TW/reference/audio/xapu/enums/xapucommandoptions)。

*context*\
類型：void\*

選擇性的使用者資料預留位置，XAPU 會在內部原封不動地傳遞此資料，從加入佇列命令階段一路傳遞到移出佇列結果階段。呼叫端可以自由傳遞任何可容納在 64 位元不帶正負號值內的資料，例如時間戳記。

## 備註

由 [XApuCommandId](/zh-TW/reference/audio/xapu/structs/xapucommandid) 用來定義傳送至 XAPU 及從 XAPU 接收的基本命令參數。所有其他命令都是從此類型擴充而來。如需解碼與轉換啟用處理參數的詳細資訊，請參閱 [XApuDecodeConvertActivateCommand](/zh-TW/reference/audio/xapu/structs/xapudecodeconvertactivatecommand) 和 [XApuDecodeConvertCommand](/zh-TW/reference/audio/xapu/structs/xapudecodeconvertcommand)。如需將命令提交至 XAPU 輸入佇列的資訊，請參閱 [XApuEnqueueCommand](/zh-TW/reference/audio/xapu/functions/xapuenqueuecommand)。

## 需求

**標頭：** xapu.h

**支援的平台：** XBOX Series X|S

## 另請參閱

[XApuDequeueResult](/zh-TW/reference/audio/xapu/functions/xapudequeueresult)\
[XApuResult](/zh-TW/reference/audio/xapu/structs/xapuresult)\
[XAPU](/zh-TW/reference/audio/xapu/xapu_members)


## Related topics

- [XApuCommandId](/reference/audio/xapu/structs/xapucommandid.md)
- [XApuDecodeConvertActivateCommand](/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md)
- [XApuCommandType](/reference/audio/xapu/enums/xapucommandtype.md)
- [XApuCommandOptions](/reference/audio/xapu/enums/xapucommandoptions.md)
- [XApuEnqueueCommand](/reference/audio/xapu/functions/xapuenqueuecommand.md)