Win32 API 日本語リファレンス
ホーム › Media.KernelStreaming › IKsFormatSupport

IKsFormatSupport

COM
📘 Microsoft Learn (日本語) · English
IID3cb4a69d-bb6f-4d2b-95b7-452d2c155db5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IKsFormatSupport インターフェースは、オーディオアダプターデバイスとシステムメモリの間の、ソフトウェアで構成された I/O 接続(通常は DMA チャネル)がサポートするオーディオデータフォーマットに関する情報を提供します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT IsFormatSupported(KSDATAFORMAT* pKsFormat, DWORD cbFormat, BOOL* pbSupported)

IsFormatSupported メソッドは、オーディオエンドポイントデバイスが指定されたオーディオストリームフォーマットをサポートするかどうかを示します。

pKsFormatKSDATAFORMAT*inoutオーディオストリームフォーマット指定子へのポインター。このパラメーターは、フォーマット指定子を含む呼び出し元が割り当てたバッファーを指します。指定子は KSDATAFORMAT 構造体で始まり、その後に追加のフォーマット情報が続く場合があります。KSDATAFORMAT およびフォーマット指定子の詳細については、Windows DDK のドキュメントを参照してください。
cbFormatDWORDinフォーマット指定子を含むバッファーのサイズ(バイト単位)。
pbSupportedBOOL*outフォーマットがサポートされているかどうかを示す値をメソッドが書き込む BOOL 変数へのポインター。デバイスがフォーマットをサポートしている場合、メソッドは TRUE を書き込み、デバイスがフォーマットをサポートしていない場合は FALSE を書き込みます。

戻り値

メソッドが成功した場合、S_OK を返します。失敗した場合、返される可能性のあるコードには、以下の表に示す値が含まれますが、これらに限定されません。

戻り値コード 説明
E_POINTER
 ポインター pKsFormat または pbSupported が NULL です。
E_INVALIDARG
 フォーマット指定子が無効です。
vtbl 4 HRESULT GetDevicePreferredFormat(KSDATAFORMAT** ppKsFormat)

GetDevicePreferredFormat メソッドは、接続に対して優先されるオーディオストリームフォーマットを取得します。

ppKsFormatKSDATAFORMAT**out優先フォーマットのフォーマット指定子を含むバッファーのアドレスをメソッドが書き込むポインター変数へのポインター。指定子は KSDATAFORMAT 構造体で始まり、その後に追加のフォーマット情報が続く場合があります。メソッドはフォーマット指定子用のストレージを割り当てます。呼び出し元は、ストレージが不要になったときに CoTaskMemFree 関数を呼び出してストレージを解放する責任があります。メソッドが失敗した場合、*ppKsFormat は NULL になります。KSDATAFORMAT、フォーマット指定子、および CoTaskMemFree の詳細については、Windows DDK のドキュメントを参照してください。

戻り値

メソッドが成功した場合、S_OK を返します。失敗した場合、返される可能性のあるコードには、以下の表に示す値が含まれますが、これらに限定されません。

戻り値コード 説明
E_POINTER
 ポインター ppKsFormat が NULL です。
E_OUTOFMEMORY
 メモリ不足です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IKsFormatSupport "{3CB4A69D-BB6F-4D2B-95B7-452D2C155DB5}"
#usecom global IKsFormatSupport IID_IKsFormatSupport "{}"
#comfunc global IKsFormatSupport_IsFormatSupported         3 var,int,var
#comfunc global IKsFormatSupport_GetDevicePreferredFormat  4 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。