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

IGraphBuilder

COM
IID56a868a9-0ad4-11ce-b03a-0020af0ba770継承元IFilterGraph自前メソッド開始 vtbl11

公式ドキュメント

このインターフェイスは、アプリケーションがフィルターグラフを構築できるようにするメソッドを提供します。

メソッド 7

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

vtbl 11 HRESULT Connect(IPin* ppinOut, IPin* ppinIn)

Connect メソッドは、必要に応じて中間フィルターを使用して 2 つのピンを接続します。

ppinOutIPin*in出力ピンの IPin インターフェイスへのポインター。
ppinInIPin*in入力ピンの IPin インターフェイスへのポインター。

戻り値

HRESULT を返します。取り得る値には次のものがあります。

Return code Description
S_OK
成功しました。
VFW_S_PARTIAL_RENDER
部分的な成功。このピンからのストリームの一部がサポートされていない形式を使用しています。
E_ABORT
操作が中止されました。
E_POINTER
NULL ポインター引数です。
VFW_E_CANNOT_CONNECT
接続を確立するための中間フィルターの組み合わせが見つかりませんでした。
VFW_E_NOT_IN_GRAPH
フィルターの少なくとも 1 つがフィルターグラフに含まれていません。

解説(Remarks)

このメソッドは、必要に応じて中間フィルターを追加しながら、2 つのピンを直接または間接的に接続します。まず直接接続を試みます。それが失敗した場合、フィルターグラフに既に存在し、未接続の入力ピンを持つフィルターの使用を試みます。(これらは任意の順序で列挙されます。) それも失敗した場合は、レジストリ内のフィルターを検索し、メリット値の順に試行します。詳細については、Intelligent Connect を参照してください。

接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。

vtbl 12 HRESULT Render(IPin* ppinOut)

Render メソッドは、指定した出力ピンからのデータをレンダリングするフィルターグラフを構築します。

ppinOutIPin*in出力ピンの IPin インターフェイスへのポインター。

戻り値

HRESULT を返します。取り得る値には次のものがあります。

Return code Description
S_OK
成功しました。
VFW_S_AUDIO_NOT_RENDERED
部分的な成功。オーディオはレンダリングされませんでした。
VFW_S_DUPLICATE_NAME
成功しました。Filter Graph Manager は重複を避けるためにフィルター名を変更しました。
VFW_S_PARTIAL_RENDER
部分的な成功。このムービー内のストリームの一部がサポートされていない形式です。
VFW_S_VIDEO_NOT_RENDERED
部分的な成功。ビデオはレンダリングされませんでした。
E_ABORT
操作が中止されました。
E_OUTOFMEMORY
メモリが不足しています。
E_POINTER
NULL ポインター引数です。
VFW_E_CANNOT_CONNECT
接続を確立するための中間フィルターの組み合わせが見つかりませんでした。
VFW_E_CANNOT_RENDER
ストリームをレンダリングするためのフィルターの組み合わせが見つかりませんでした。
VFW_E_NO_ACCEPTABLE_TYPES
これらのピンの間に共通のメディアタイプがありません。
VFW_E_NOT_IN_GRAPH
このピンが属するフィルターがフィルターグラフに含まれていません。

解説(Remarks)

このメソッドは、必要に応じてグラフに新しいフィルターを追加しながら、指定した出力ピンからのデータをレンダリングします。フィルターは IGraphBuilder::Connect メソッドと同じ順序で試行されます。詳細については、Intelligent Connect を参照してください。

接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。

vtbl 13 HRESULT RenderFile(LPWSTR lpcwstrFile, LPWSTR lpcwstrPlayList)

RenderFile メソッドは、指定したファイルをレンダリングするフィルターグラフを構築します。(IGraphBuilder.RenderFile)

lpcwstrFileLPWSTRinメディアファイルの名前を含むワイド文字列を指定します。
lpcwstrPlayListLPWSTRinoptional予約済み。NULL にする必要があります。

戻り値

HRESULT を返します。取り得る値には次のものがあります。

Return code Description
S_OK
成功しました。
VFW_S_AUDIO_NOT_RENDERED
部分的な成功。オーディオはレンダリングされませんでした。
VFW_S_DUPLICATE_NAME
成功しました。Filter Graph Manager は重複を避けるためにフィルター名を変更しました。
VFW_S_PARTIAL_RENDER
このムービー内のストリームの一部がサポートされていない形式です。
VFW_S_VIDEO_NOT_RENDERED
部分的な成功。このムービー内のストリームの一部がサポートされていない形式です。
E_ABORT
操作が中止されました。
E_FAIL
失敗しました。
E_INVALIDARG
引数が無効です。
E_OUTOFMEMORY
メモリが不足しています。
E_POINTER
NULL ポインター引数です。
VFW_E_CANNOT_CONNECT
接続を確立するための中間フィルターの組み合わせが見つかりませんでした。
VFW_E_CANNOT_LOAD_SOURCE_FILTER
このファイルのソースフィルターを読み込めませんでした。
VFW_E_CANNOT_RENDER
ストリームをレンダリングするためのフィルターの組み合わせが見つかりませんでした。
VFW_E_INVALID_FILE_FORMAT
ファイル形式が無効です。
VFW_E_NOT_FOUND
オブジェクトまたは名前が見つかりませんでした。
VFW_E_UNKNOWN_FILE_TYPE
このファイルのメディアタイプが認識されません。
VFW_E_UNSUPPORTED_STREAM
ファイルを再生できません。この形式はサポートされていません。

解説(Remarks)

lpwstrFile パラメーターがメディアファイルを指定している場合、このメソッドは既定の再生用のフィルターグラフを構築します。まず、IGraphBuilder::AddSourceFilter メソッドと同じ処理を使用して、そのファイルを読み取ることができるソースフィルターを追加します。次に、必要に応じて中間フィルターを追加しながら、ソースフィルターの出力ピンをレンダリングします。フィルターは IGraphBuilder::Connect メソッドと同じ順序で試行します。

接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。

RenderFile メソッドはグラフからフィルターを削除しないことに注意してください。RenderFile を 2 回呼び出すと、2 回目の呼び出しは単にグラフにさらにフィルターを追加します。グラフを実行すると、両方のソースが同時に再生されます。

次の例では、既定の再生用に AVI ファイルをレンダリングします。

C++
hr = pGraph->RenderFile(L"C:\\Media\\Example.avi", 0);
次の例では、File Source (URL) フィルターを使用して、HTTP 経由で AVI ファイルをダウンロードします。
C++
hr = pGraph->RenderFile(L"http://example.microsoft.com/Example.avi", 0);
vtbl 14 HRESULT AddSourceFilter(LPWSTR lpcwstrFileName, LPWSTR lpcwstrFilterName, IBaseFilter** ppFilter)

AddSourceFilter メソッドは、指定したファイルのソースフィルターをフィルターグラフに追加します。

lpcwstrFileNameLPWSTRin読み込むファイルの名前を指定します。
lpcwstrFilterNameLPWSTRinoptionalソースフィルターの名前を指定します。
ppFilterIBaseFilter**outフィルターの IBaseFilter インターフェイスへのポインターを受け取ります。呼び出し側はインターフェイスを解放する必要があります。

戻り値

HRESULT を返します。取り得る値には次のものがあります。

Return code Description
S_OK
成功しました。
E_NOINTERFACE
ソースフィルターが IFileSourceFilter インターフェイスをサポートしていません。
E_OUTOFMEMORY
メモリが不足しています。
E_POINTER
NULL ポインター引数です。
VFW_E_CANNOT_LOAD_SOURCE_FILTER
このファイルのソースフィルターを読み込めませんでした。
VFW_E_NOT_FOUND
ファイルまたはオブジェクトが見つかりませんでした。
VFW_E_UNKNOWN_FILE_TYPE
このファイルのメディアタイプが認識されませんでした。

解説(Remarks)

このメソッドは、指定したファイルを読み取ることができるインストール済みのフィルターを検索します。見つかった場合、メソッドはそれをフィルターグラフに追加し、そのフィルターの IBaseFilter インターフェイスへのポインターを返します。ファイルのメディアタイプと圧縮方式を判別するために、Filter Graph Manager は、記事 Registering a Custom File Type に記載されているように、ファイルの先頭の数バイトを読み取り、特定のバイトパターンを探します。

フィルターグラフの残りの部分を構築するのは、アプリケーションの責任です。そのためには、IBaseFilter::EnumPins を呼び出してソースフィルターの出力ピンを列挙します。その後、IGraphBuilder::Connect メソッドまたは IGraphBuilder::Render メソッドのいずれかを使用します。

メソッドが成功した場合、IBaseFilter インターフェイスには未解放の参照カウントが残ります。呼び出し側はインターフェイスを解放する必要があります。

ファイルを既定の再生用にレンダリングするには、IGraphBuilder::RenderFile メソッドを使用します。

Filter Graph Manager は、フィルターがグラフから削除されるか、Filter Graph Manager が解放されるまで、そのフィルターの参照カウントを保持します。

vtbl 15 HRESULT SetLogFile(UINT_PTR hFile)

SetLogFile メソッドは、操作の実行を試みる際に行われるアクションをログに記録するためのファイルを設定します。

hFileUINT_PTRinログファイルへのハンドル。

戻り値

S_OK を返します。

解説(Remarks)

このメソッドはデバッグで使用するためのものであり、フィルターグラフの自動構築に失敗した原因を特定するのに役立つことを意図しています。

hFile パラメーターは、開かれているファイルハンドルである必要があります。ファイルを開くこと、およびログ記録の完了時にそれを閉じることは、アプリケーションの責任です。ファイルハンドルを閉じる前に、NULL のファイルハンドルを指定して SetLogFile を呼び出してください。これにより、ファイルを閉じた後にコンポーネントがそのファイルハンドルを使用しようとしないことが保証されます。

vtbl 16 HRESULT Abort()

Abort メソッドは、Filter Graph Manager に対して、現在のタスクをできるだけ早く停止するよう要求します。

戻り値

S_OK を返します。

vtbl 17 HRESULT ShouldOperationContinue()

ShouldOperationContinue メソッドは、現在の操作を続行すべきかどうかを問い合わせます。

戻り値

HRESULT を返します。取り得る値には次のものがあります。

Return code Description
S_OK
現在の操作を続行すべきです。
S_FALSE
現在の操作を続行すべきではありません。
E_UNEXPECTED
予期しないエラーです。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IGraphBuilder "{56A868A9-0AD4-11CE-B03A-0020AF0BA770}"
#usecom global IGraphBuilder IID_IGraphBuilder "{}"
#comfunc global IGraphBuilder_Connect                  11 sptr,sptr
#comfunc global IGraphBuilder_Render                   12 sptr
#comfunc global IGraphBuilder_RenderFile               13 wstr,wstr
#comfunc global IGraphBuilder_AddSourceFilter          14 wstr,wstr,sptr
#comfunc global IGraphBuilder_SetLogFile               15 sptr
#comfunc global IGraphBuilder_Abort                    16
#comfunc global IGraphBuilder_ShouldOperationContinue  17
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。