IAudioSystemEffects2::GetEffectsList メソッド (audioenginebaseapo.h)

GetEffectsList メソッドは、現在アクティブなオーディオ処理効果の一覧を取得するために使用され、リストが変更された場合に通知されるイベントを格納します。

構文

HRESULT GetEffectsList(
  [out] LPGUID *ppEffectsIds,
  [out] UINT   *pcEffects,
  [in]  HANDLE Event
);

パラメーター

[out] ppEffectsIds

オーディオ処理効果を表す GUID の一覧へのポインター。 呼び出し元は、CoTaskMemFree を呼び出してこのメモリを解放する必要があります。

[out] pcEffects

リスト内のオーディオ処理効果の数。

[in] Event

リストが変更された場合に通知されるイベントの HANDLE。

戻り値

GetEffectsList メソッドは、メソッド呼び出しが成功した場合、S_OKを返します。 リストに効果がない場合でも、関数は成功し、 ppEffectsIds は NULL ポインターを返し、 pcEffects は 0 のカウントを返します。

注釈

APO は、 GetEffectsList によって返されたリストからオーディオ処理効果の一覧が変更されたときに、指定されたイベントを通知します。 APO は 、GetEffectsList が再度呼び出されるか、APO が破棄されるまで、このイベントを使用します。 渡されたハンドルは NULL にすることができます。この場合、APO は以前のハンドルの使用を停止し、イベントを通知しません。

APO では、このメソッドを実装して、Windows が APO によって適用されている現在の効果を検出できるようにします。 効果の一覧は、APO が初期化した処理モードと、エンド ユーザーの構成によって異なります。 処理モードは、APOInitSystemEffects2 の AudioProcessingMode メンバーによって示されます。

API では、Windows で定義された GUID (AUDIO_EFFECT_TYPE_ACOUSTIC_ECHO_CANCELLATIONなど) を使用して効果を識別する必要があります。 APO では、効果の種類が Windows で定義されたものと明らかに異なる場合にのみ、カスタム GUID を定義して返す必要があります。

要件

要件	値
対象プラットフォーム	デスクトップ
Header	audioenginebaseapo.h

こちらもご覧ください

APOInitSystemEffects2

IAudioSystemEffects2