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

# XDspActivate

> XDspActivate

# XDspActivate

プールから空き処理リソースを取得することで XDSP ストリームをアクティブ化します。各 XDSP クライアントは 256 個のストリーム アクティブ化に制限されています。

## 構文

```cpp theme={null}
HRESULT XDspActivate(  
         XDspClientHandle clientHandle,  
         XDspActivationParameters* params,  
         XDspStatus** status,  
         XDspStreamHandle* streamHandle  
)  
```

### パラメーター

*clientHandle*   \_In\_\
型: [XDspClientHandle](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspclienthandle.md)

XDspConnect の呼び出しから取得した有効な XDSP クライアント ハンドル。

*params*   \_In\_\
型: [XDspActivationParameters\*](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspactivationparameters.md)

[XDspActivationParameters](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspactivationparameters.md) 構造体へのポインター。

*status*   \_Outptr\_\
型: [XDspStatus\*\*](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspstatus.md)

[XDspStatus](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspstatus.md) 構造体へのポインター。詳細については、**解説** セクションを参照してください。

*streamHandle*   \_Outptr\_\
型: [XDspStreamHandle\*](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspstreamhandle.md)

呼び出しが成功した場合の、有効な [XDspStreamHandle](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspstreamhandle.md)。詳細については、**解説** セクションを参照してください。

### 戻り値

型: HRESULT

メソッドが成功した場合は S\_OK を返します。失敗した場合は次のコードのいずれかを返します (一部の一覧):

| 戻りコード | 説明 |
| - | - |
| E\_POINTER | 有効でないポインター。 |
| E\_INVALIDARG | 1 つ以上の引数が無効です。 |
| XDSP\_E\_NO\_DEVICE\_RESOURCES | 要求を処理するために利用可能な XDSP デバイス リソースがありません。 |
| XDSP\_E\_INVALID\_IMPULSE\_RESPONSE\_LENGTH | 指定されたインパルス応答長が無効です。このエラーは、(`9 * blockSize * 2`) 未満、または 16 秒 (`16 * 48000 * 2`) を超える [impulseResponseLengthInFloats](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspactivationparameters.md) が指定された場合に発生することがあります。 |

## 解説

この呼び出しは、リソースを割り当てるのではなくプールから取得するため、高速です。

呼び出し元は、XDSP ストリームが実行する [XDspProcessType](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/enums/xdspprocesstype.md) を指定する必要があります。XDSP ストリームのインスタンスは、そのライフタイム中に 1 つの処理タイプのみで動作できます。2 つ以上の異なる処理タイプを実行するには、2 つ以上の XDSP ストリーム インスタンスをインスタンス化する必要があります。

[XDspActivationParameters](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspactivationparameters.md) 構造体内で、呼び出し元は次を指定する必要があります:

* アクティベーション オプション。
* 各コマンドで処理されるフレーム数 (入力および出力のフレーム数)。
* ストリームのチャネル数。モノラルおよびステレオの入力ストリームのみがサポートされます。
* [XDspProcessType::Convolution](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/enums/xdspprocesstype.md) 処理タイプの場合、float 単位のインパルス応答長。
* [XDspProcessType::Convolution](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/enums/xdspprocesstype.md) 処理タイプの場合、周波数領域の値としてのインパルス応答。

呼び出しが成功すると、このストリームに対する他の呼び出し ([XDspSubmitCommand](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/functions/xdspsubmitcommand.md)、[XDspSubmitCommandWithEnvelope](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/functions/xdspsubmitcommandwithenvelope.md)、[XDspDeactivate](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/functions/xdspdeactivate.md)) で使用する有効な [XDspStreamHandle](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspstreamhandle.md) が返されます。また、この呼び出しが成功すると、送信されたコマンドの状態を確認するために使用できる [XDspStatus](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspstatus.md) へのポインターが返されます。

これは、処理された最新のコマンドと、送信されたコマンドの結果を消費する準備ができているかどうかを判断するために使用する必要があります。
[XDspStatus](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/structs/xdspstatus.md) には、ハードウェアに送信された最後のコマンドのシーケンス番号と、それが表す XDSP ストリームの最初に失敗したコマンドのシーケンス番号もあります。畳み込み処理の場合、呼び出し元はこの呼び出しが返った後にインパルス応答のメモリを解放できます。

## 要件

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

**ライブラリ:** Chad.lib

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

## 概念ドキュメント

* [XDSP API を使用したエンベロープ付き単一ストリーム畳み込みの概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution-with-envelope.md)
* [XDSP API を使用した単一ストリーム畳み込みの概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution.md)
* [XDSP の概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview.md)

## 関連項目

[XDSP](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/xdspaudio_members.md)\
[XDSP エラー](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/enums/xdsperrors.md)\
[XDSP API を使用した単一ストリーム畳み込みの概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution.md)\
[XDSP API を使用した単一ストリーム FFT/IFFT の概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-fft-ifft.md)\
[XDSP API を使用したエンベロープ付き単一ストリーム畳み込みの概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution-with-envelope.md)


## Related topics

- [XDspDeactivate](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/functions/xdspdeactivate.md)
- [XDspClientHandle](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspclienthandle.md)
- [XDspStreamHandle](https://docs.xbox.com/ja-jp/reference/audio/xdspaudio/handles/xdspstreamhandle.md)
- [XDSP の概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview.md)
- [XDSP API を使用したシングル ストリーム コンボリューションの概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/xdsp-overview-single-stream-convolution.md)