IAudioProcessingObject

System Effects Audio Processing Objects (sAPO) は、通常、リアルタイム処理スレッドで使用されるか、そこから呼び出されます。

Reset メソッドは、APO を元の状態にリセットします。このメソッドは、APO の入力または出力に接続されている接続オブジェクトに変更を加えません。

Reset メソッドは、呼び出しが正常に完了すると S_OK の値を返します。

このメソッドはリアルタイム対応ではなく、リアルタイム処理スレッドから呼び出してはなりません。このメソッドの実装は、ページ メモリに触れることはなく、また触れてはなりません。さらに、ブロッキングを伴うシステム ルーチンを呼び出してはなりません。

GetLatency メソッドは、この APO のレイテンシを返します。レイテンシとは、フレームが APO の処理パスを通過するのにかかる時間です。

GetLatency は、呼び出しが成功した場合に S_OK の値を返します。それ以外の場合は、無効なポインターが関数に渡されたことを示すエラー コード E_POINTER を返します。

この APO を呼び出しているクライアントがサンプリング レートを把握している場合、クライアントはレイテンシをフレーム数の観点で計算できます。オーディオ信号処理ストリーム全体の合計レイテンシを取得するには、クライアントは処理チェーン内のすべての APO に問い合わせ、その結果を合計する必要があります。

GetRegistrationProperties は、オーディオ処理オブジェクト (APO) の登録プロパティを返します。

GetRegistrationProperties は、呼び出しが成功した場合に S_OK の値を返します。それ以外の場合は、無効なポインターが関数に渡されたことを示すエラー コード E_POINTER を返します。

呼び出し元は、GetRegistrationProperties が返したメモリを解放する必要があります。

Initialize メソッドは、APO を初期化し、可変長のデータをサポートします。

Initialize メソッドは、呼び出しが成功した場合に S_OK の値を返します。それ以外の場合、このメソッドは次のいずれかのエラー コードを返します。

データを初期化する必要なく APO を初期化するためにこのメソッドを使用する場合は、pbyData パラメーターの値として NULL を、cbDataSize パラメーターの値として 0 (ゼロ) を指定してかまいません。指定するデータは可変長であり、次の形式でなければなりません。

Struct MyAPOInitializationData
{
APOInitBaseStruct APOInit;
// list additional struct members here
// ...
};

このメソッドは、Windows Vista のオーディオ エンジンとネゴシエーションを行い、オーディオ データのストリームのデータ形式を確立します。

呼び出しが正常に完了した場合、ppSupportedInputFormat パラメーターは pRequestedInputFormat ポインターを返し、IsInputFormatSupported メソッドは S_OK の値を返します。それ以外の場合、このメソッドは次のいずれかのエラー コードを返します。

IsInputFormatSupported メソッドの実装は、APO ごとに違いがあります。たとえば、特定の実装では、入力形式が整数型の場合、出力は float 型のみになることがあります。

形式ネゴシエーションを開始するために、オーディオ サービスはまず LFX sAPO の出力を既定の float32 ベースの形式に設定します。次にオーディオ サービスは、LFX sAPO の IAudioProcessingObject::IsInputFormatSupported メソッドを呼び出し、既定の形式を提案し、このメソッドの HRESULT の応答を監視します。LFX sAPO の入力が提案された形式をサポートできる場合は、サポートされている形式への参照とともに S_OK を返します。LFX sAPO の入力が提案された形式をサポートできない場合は、提案された形式に最も近い形式への参照とともに S_FALSE を返します。LFX sAPO が提案された形式をサポートできず、近い形式もない場合は、APOERR_FORMAT_NOT_SUPPORTED を返します。GFX sAPO は LFX sAPO の出力形式で動作します。そのため、GFX sAPO は形式ネゴシエーションのプロセスには関与しません。

IsOutputFormatSupported メソッドは、特定の出力形式がサポートされていることを検証するために使用されます。

呼び出しが正常に完了した場合、ppSupportedOutputFormat パラメーターは pRequestedOutputFormat ポインターを返し、IsOutputFormatSupported メソッドは S_OK の値を返します。それ以外の場合、このメソッドは次のいずれかのエラー コードを返します。

IsOutputFormatSupported メソッドの実装は、APO ごとに違いがあります。たとえば、特定の実装では、入力形式が整数型の場合、出力は float 型のみになることがあります。

GetInputChannelCount は、この APO の入力チャネル数 (フレームあたりのサンプル数) を返します。

GetInputChannelCount は、呼び出しが成功した場合に S_OK の値を返します。

返される入力チャネル数は、APO の入力側を指します。