IAudioSystemEffectsCustomFormats::GetFormat メソッド (audioenginebaseapo.h)
メソッドは GetFormat
、カスタム形式の IAudioMediaType 表現を取得します。
構文
HRESULT GetFormat(
[in] UINT nFormat,
[out, optional] IAudioMediaType **ppFormat
);
パラメーター
[in] nFormat
サポートされている形式のインデックスを指定します。 このパラメーターには、 GetFormatCount の戻り値より 0 から 1 未満の範囲の任意の値を指定できます。 つまり、0 から GetFormatCount( ) - 1 までの範囲の任意の値です。
[out, optional] ppFormat
IAudioMediaType インターフェイスへのポインターへのポインターを指定します。 呼び出し元は、ppFormat パラメーターが指す IAudioMediaType インターフェイスを解放する必要があります。
戻り値
メソッドは GetFormat
、呼び出しが成功したときにS_OKを返します。 それ以外の場合は、次の表に示すエラー コードのいずれかを返します。
リターン コード | 説明 |
---|---|
|
無効なポインターが関数に渡されました |
|
戻りバッファーを割り当てることができません |
|
nFormat が範囲外です |
注釈
オーディオ システムが メソッドを GetFormat
呼び出すと、sAPO はオーディオ メディアの種類オブジェクトを作成し、 IAudioMediaType インターフェイスを返します。 sAPO 実装では、 CreateAudioMediaType ユーティリティ関数を使用してオーディオ メディアの種類オブジェクトを作成できます。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista 以降のバージョンの Windows で使用できます。 |
対象プラットフォーム | デスクトップ |
Header | audioenginebaseapo.h (Audioenginebaseapo.h を含む) |
IRQL | すべてのレベル。 |