> ## 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 から受信する基本コマンド パラメーターを定義します。その他のすべてのコマンドは、この型を拡張したものです。

## 構文

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

### メンバー

*type*\
型: [XApuCommandType](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandtype.md)

このコマンド内の関連データをハードウェアがどのように処理するかを指示するコマンド種別。

*streamIndex*\
型: uint32\_t

ストリームのインデックス。値は 0 から [XApuConnectInputParameters::maxStreamCount](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapuconnectinputparameters.md) - 1 の範囲である必要があります。すべてのストリームは一意のインデックス値を持つ必要があり、この値を割り当てるのは呼び出し側の責任です。

*sequence*\
型: uint32\_t

この値は XAPU では変更されず、使用方法は呼び出し側に委ねられます。結果キューから出力されるパケットを追跡するために時間とともに増加するコマンド シーケンス番号として使用できます。XAPU はこのシーケンス番号に従ってパケットの順序を並べ替えることはなく、この番号が減少したり前の値との間に欠落があってもエラーを返しません。

*options*\
型: [XApuCommandOptions](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandoptions.md)

コマンド オプション。一部のオプションは [XApuCommandOptions::SignalOnCompletion](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandoptions.md) のようにすべてのコマンド種別に適用できます。それ以外は [XApuCommandOptions::Flush](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandoptions.md) や [XApuCommandOptions::Decoder](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandoptions.md) のように特定のコマンド種別に対して機能します。

*context*\
型: void\*

XAPU がエンキュー コマンド段階からデキュー結果段階まで、そのまま内部で受け渡すユーザー データのためのオプションのプレース ホルダーです。呼び出し側はタイムスタンプなど、64 ビット符号なし値に収まる任意のデータを自由に渡すことができます。

## 解説

[XApuCommandId](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapucommandid.md) は、XAPU に送信され、XAPU から受信される基本コマンド パラメーターを定義するために使用されます。その他のすべてのコマンドは、この型を拡張したものです。デコード変換のアクティブ化処理パラメーターの詳細については、[XApuDecodeConvertActivateCommand](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md) と [XApuDecodeConvertCommand](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapudecodeconvertcommand.md) を参照してください。XAPU 入力キューにコマンドを送信する方法については、[XApuEnqueueCommand](https://docs.xbox.com/ja-jp/reference/audio/xapu/functions/xapuenqueuecommand.md) を参照してください。

## 要件

**ヘッダー:** xapu.h

**サポートされているプラットフォーム:** XBOX Series X|S

## 関連項目

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


## Related topics

- [XApuCommandType](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandtype.md)
- [XApuCommandOptions](https://docs.xbox.com/ja-jp/reference/audio/xapu/enums/xapucommandoptions.md)
- [XApuDecodeConvertActivateCommand](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapudecodeconvertactivatecommand.md)
- [XApuEnqueueCommand](https://docs.xbox.com/ja-jp/reference/audio/xapu/functions/xapuenqueuecommand.md)
- [XApuConnectInputParameters](https://docs.xbox.com/ja-jp/reference/audio/xapu/structs/xapuconnectinputparameters.md)