ホーム › Media.WindowsMediaFormat › IWMWriterSink

IWMWriterSink

COM

IID96406be4-2b2b-11d3-b36b-00c04f6108ff継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWMWriterSink インターフェイスは、Windows Media Format SDK で定義されているファイルシンク、ネットワークシンク、プッシュシンク、およびカスタムシンクを含む、すべてのライターシンクの基本インターフェイスです。

メソッド 5

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

vtbl 3 HRESULT OnHeader(INSSBuffer* pHeader)

OnHeader メソッドは、ASF ヘッダーがシンクに渡せる状態になったときにライターによって呼び出されます。

pHeader

INSSBuffer*

ASF ヘッダーを格納するオブジェクトの INSSBuffer インターフェイスへのポインター。

戻り値

このメソッドはアプリケーションによって実装されます。常に S_OK を返す必要があります。

解説(Remarks)

ヘッダーはコンテンツの読み取りに必須であるため、ASF ヘッダーは必ずいずれのデータユニットよりも前に送信されます。ライターは、特定のファイルに対してヘッダーを複数回送信する場合があります。可能であれば、シンクは受け取ったヘッダーを書き込むようにしてください。

vtbl 4 HRESULT IsRealTime(BOOL* pfRealTime)

IsRealTime は、シンクがデータユニットのリアルタイム配信を必要とするかどうかを判断するためにライターによって呼び出されます。カスタムシンクがリアルタイム配信を必要とするかどうかは、実装者が判断します。

pfRealTime

BOOL*

out

シンクがデータユニットのリアルタイム配信を必要とする場合に True となるブール値へのポインター。

戻り値

このメソッドはアプリケーションによって実装されます。常に S_OK を返す必要があります。

vtbl 5 HRESULT AllocateDataUnit(DWORD cbDataUnit, INSSBuffer** ppDataUnit)

AllocateDataUnit メソッドは、ライターオブジェクトがデータユニットを配信するためのバッファーを必要とするときに呼び出されます。

cbDataUnit	DWORD	in	ライターが配信する必要があるデータユニットのサイズ (バイト単位)。ppDataUnit に割り当てるバッファーは、このサイズ以上である必要があります。
ppDataUnit	INSSBuffer**	out	戻り時に、バッファーオブジェクトの INSSBuffer インターフェイスへのポインターに設定されます。

戻り値

このメソッドはアプリケーションによって実装されます。常に S_OK を返す必要があります。

vtbl 6 HRESULT OnDataUnit(INSSBuffer* pDataUnit)

OnDataUnit メソッドは、データユニットがシンクに渡せる状態になったときにライターによって呼び出されます。アプリケーションがデータユニットをどのように処理するかは、コンテンツの送信先によって異なります。

pDataUnit

INSSBuffer*

データユニットを格納するオブジェクトの INSSBuffer インターフェイスへのポインター。

戻り値

このメソッドはアプリケーションによって実装されます。常に S_OK を返す必要があります。

vtbl 7 HRESULT OnEndWriting()

OnEndWriting メソッドは、書き込みが完了したときにライターによって呼び出されます。このメソッドでは、シンクの処理を締めくくる操作を行う必要があります。たとえば、ライターのファイルシンクはファイルを閉じてインデックスを作成します。

戻り値

このメソッドはアプリケーションによって実装されます。常に S_OK を返す必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWMWriterSink "{96406BE4-2B2B-11D3-B36B-00C04F6108FF}"
#usecom global IWMWriterSink IID_IWMWriterSink "{}"
#comfunc global IWMWriterSink_OnHeader          3 sptr
#comfunc global IWMWriterSink_IsRealTime        4 var
#comfunc global IWMWriterSink_AllocateDataUnit  5 int,sptr
#comfunc global IWMWriterSink_OnDataUnit        6 sptr
#comfunc global IWMWriterSink_OnEndWriting      7
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWMWriterSink "{96406BE4-2B2B-11D3-B36B-00C04F6108FF}"
#usecom global IWMWriterSink IID_IWMWriterSink "{}"
#comfunc global IWMWriterSink_OnHeader          3 sptr
#comfunc global IWMWriterSink_IsRealTime        4 sptr
#comfunc global IWMWriterSink_AllocateDataUnit  5 int,sptr
#comfunc global IWMWriterSink_OnDataUnit        6 sptr
#comfunc global IWMWriterSink_OnEndWriting      7
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。