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

IWMWriterFileSink2

COM
📘 Microsoft Learn (日本語) · English
IID14282ba7-4aef-4205-8ce5-c229035a05bc継承元IWMWriterFileSink自前メソッド開始 vtbl9

公式ドキュメント

IWMWriterFileSink2 インターフェイスは、ファイルシンクの拡張的な管理を提供します。このインターフェイスは、IWMWriterFileSink インターフェイスの QueryInterface メソッドを呼び出すことで取得できます。

メソッド 7

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

vtbl 9 HRESULT Start(ULONGLONG cnsStartTime)

Start メソッドは、指定した時刻に記録を開始します。

cnsStartTimeULONGLONGin開始時刻(100 ナノ秒単位)。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは成功しました。
NS_E_INVALID_REQUEST
 要求された開始時刻が、最後の停止時刻より前です。
E_OUTOFMEMORY
 タスクを完了するのに十分なメモリがありません。

解説(Remarks)

シンクが停止されていない限り、このメソッドを呼び出す必要はありません。シンクは、IWMWriterAdvanced::AddSink を使用してライターに追加されると、(時刻 0 で)自動的に開始されます。

ファイル内の特定の位置では、わずかに異なるタイムスタンプを持つストリームがインターリーブされるため、実際の開始時刻は cnsStartTime で指定したとおりにはならない場合があります。精度を高めるには、IWMWriterFileSink3::SetControlStream を呼び出してください。

vtbl 10 HRESULT Stop(ULONGLONG cnsStopTime)

Stop メソッドは、指定した時刻に記録を停止します。

cnsStopTimeULONGLONGin停止時刻(100 ナノ秒単位)。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

ファイル内の特定の位置では、わずかに異なるタイムスタンプを持つストリームがインターリーブされるため、実際の停止時刻は cnsStopTime で指定したとおりにはならない場合があります。精度を高めるには、IWMWriterFileSink3::SetControlStream を呼び出してください。

vtbl 11 HRESULT IsStopped(BOOL* pfStopped)

IsStopped メソッドは、ファイルシンクが書き込みを停止したかどうかを確認します。

pfStoppedBOOL*out書き込みが停止している場合に True に設定される Boolean 値へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pfStopped パラメーターが NULL です。
vtbl 12 HRESULT GetFileDuration(ULONGLONG* pcnsDuration)

GetFileDuration メソッドは、書き込み済みのファイル部分の長さ(再生時間)を取得します。

pcnsDurationULONGLONG*out長さ(100 ナノ秒単位)を指定する変数へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pcnsDuration パラメーターが NULL です。
vtbl 13 HRESULT GetFileSize(ULONGLONG* pcbFile)

GetFileSize メソッドは、ファイルのサイズを取得します。

pcbFileULONGLONG*outファイル内のバイト数へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pcbFile パラメーターが NULL です。
vtbl 14 HRESULT Close()

Close メソッドは、シンクを閉じます。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

IWMWriter::BeginWriting の「解説」および「サンプルコード」のセクションを参照してください。

vtbl 15 HRESULT IsClosed(BOOL* pfClosed)

IsClosed メソッドは、ファイルシンクが閉じられたかどうかを確認します。

pfClosedBOOL*outファイルシンクが閉じられている場合に True に設定される Boolean 値へのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値コード 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 pfClosed パラメーターが NULL です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWMWriterFileSink2 "{14282BA7-4AEF-4205-8CE5-C229035A05BC}"
#usecom global IWMWriterFileSink2 IID_IWMWriterFileSink2 "{}"
#comfunc global IWMWriterFileSink2_Start            9 int64
#comfunc global IWMWriterFileSink2_Stop             10 int64
#comfunc global IWMWriterFileSink2_IsStopped        11 var
#comfunc global IWMWriterFileSink2_GetFileDuration  12 var
#comfunc global IWMWriterFileSink2_GetFileSize      13 var
#comfunc global IWMWriterFileSink2_Close            14
#comfunc global IWMWriterFileSink2_IsClosed         15 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。