IMiniportAudioSignalProcessing::GetModes メソッド (portcls.h)

GetModes メソッドは、オーディオ ピンでサポートされているオーディオ信号処理モードを取得します。

構文

NTSTATUS GetModes(
  [in]            ULONG Pin,
  [out, optional] GUID  *SignalProcessingModes,
  [in, out]       ULONG *NumSignalProcessingModes
);

パラメーター

[in] Pin

オーディオ ピンのインデックス。

[out, optional] SignalProcessingModes

このパラメーターは省略可能です。 Pin パラメーターでサポートされている信号処理モードを識別する GUID の配列を返します。

[in, out] NumSignalProcessingModes

入力として使用する場合、 SignalProcessingModes で指定されたバッファーに書き込むことができる要素の数を指定します。 出力として使用すると、バッファーに書き込まれた要素の数が返されます。

戻り値

GetModes は、 呼び出しが成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合、メソッドは適切なエラー コードを返します。

注釈

SignalProcessingModes が NULL の場合、GetModes はサポートされているモードの数を NumSignalProcessingModes に書き込み、STATUS_SUCCESSを返します。 これにより、呼び出し元は、バッファーを割り当てるために、サポートされているモードの数に対してクエリを実行できます。

SignalProcessingModes が NULL でない場合、GetModes は NumSignalProcessingModes がサポートされているモードの数以上であることを確認します。 その場合、メソッドはサポートされているモード を SignalProcessingModes バッファーに書き込み、サポートされているモードの実際の数 を NumSignalProcessingModes に書き込み、STATUS_SUCCESSを返します。

次の表では、 GetModes で返すことができるエラー メッセージを示し、説明します。

エラー コード	説明
STATUS_BUFFER_TOO_SMALL	NumSignalProcessingModes 用に確保されたバッファーが小さすぎます。
STATUS_INVALID_PARAMETER	Pin パラメーターの値は、>= フィルター上のピン ファクトリの数である Pin ID を示します。 ピン インデックスは 0 から始まるため、フィルター上の n 個のピン ファクトリの場合、インデックスの最大値は n-1 である必要があります。
STATUS_NOT_SUPPORTED	シグナル処理モードをサポートしないピンに対して Pin ID が指定されました。 たとえば、Pin ID がオーディオ ループバック ピンまたはブリッジ ピンを参照している場合、 GetModes はこのエラー コードを返します。

要件

要件	値
サポートされている最小のクライアント	Windows 8.1
サポートされている最小のサーバー	Windows Server 2012 R2
対象プラットフォーム	ユニバーサル
Header	portcls.h

こちらもご覧ください

IMiniportAudioSignalProcessing