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

IStreamBufferRecordControl

COM
📘 Microsoft Learn (日本語) · English
IIDba9b6c99-f3c7-4ff2-92db-cfdd4851bf31継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IStreamBufferRecordControl インターフェイスは、ストリームバッファーの Recording オブジェクトを制御するために使用します。新しい Recording オブジェクトを作成するには、Stream Buffer Sink フィルターの IStreamBufferSink::CreateRecorder メソッドを使用します。

解説(Remarks)

このインターフェイスのインターフェイス識別子 (IID) を宣言するには、__uuidof 演算子を使用します: __uuidof(IStreamBufferRecordControl)。

メソッド 3

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

vtbl 3 HRESULT Start(LONGLONG* prtStart)

Start メソッドは録画を開始します。

prtStartLONGLONG*inout

開始時刻を格納する変数へのポインター。時刻は現在のストリーム時刻を基準とし、100 ナノ秒単位で表します。値 0 は現在を表し、負の値は過去、正の値は未来を表します。

コンテンツ録画の場合、時刻は 0 から 5 秒 (50000000) までの範囲 (両端を含む) の値でなければなりません。負の時刻は無効です。

リファレンス録画の場合、負の時刻は既存のコンテンツの範囲内であれば有効です。prtStart に指定した時刻が有効な最も古いコンテンツより前の場合は、代わりに実際のコンテンツの開始時刻が使用されます。この値はメソッドが戻るときに prtStart に返されます。

戻り値

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

戻り値 説明
E_INVALIDARG
 時刻が無効です。
E_POINTER
 NULL ポインター引数です。
S_OK
 メソッドは成功しました。

解説(Remarks)

開始時刻は停止時刻以下でなければなりません。

vtbl 4 HRESULT Stop(LONGLONG rtStop)

Stop メソッドは録画を停止し、ファイルを閉じます。

rtStopLONGLONGin

録画を停止するタイミングを指定します。時刻は現在のストリーム時刻を基準とし、100 ナノ秒単位で表します。値 0 は現在を表し、負の値は過去、正の値は未来を表します。

コンテンツ録画の場合、有効な範囲は 0 から 5 秒 (50000000) まで (両端を含む) です。負の時刻は無効です。

リファレンス録画の場合、負の時刻は有効に録画されたコンテンツの範囲内であれば有効です。

戻り値

このメソッドは HRESULT を返します。取り得る値には次の表に示すものがありますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。

解説(Remarks)

停止時刻は開始時刻以上でなければなりません。

vtbl 5 HRESULT GetRecordingStatus(HRESULT* phResult, BOOL* pbStarted, BOOL* pbStopped)

GetRecordingStatus メソッドは録画の状態を取得します。

phResultHRESULT*outHRESULT 値を受け取る変数へのポインター。この HRESULT 値は、ファイルへの書き込みまたはファイルのクローズの現在の状態を示します。このパラメーターは NULL にできます。
pbStartedBOOL*out

録画が開始されたかどうかを示すブール値を受け取る変数へのポインター。

値 説明
TRUE 録画は開始されています。
FALSE 録画は開始されていません。

このパラメーターは NULL にできます。

pbStoppedBOOL*out

録画が停止されたかどうかを示すブール値を受け取る変数へのポインター。

値 説明
TRUE 録画は停止されています。
FALSE 録画は停止されていない、またはまだ開始されていません。

このパラメーターは NULL にできます。

戻り値

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

戻り値 説明
S_OK
 メソッドは成功しました。

解説(Remarks)

このメソッドは、Start および Stop メソッドの状態を報告します。これらのメソッド自体は非同期です。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IStreamBufferRecordControl "{BA9B6C99-F3C7-4FF2-92DB-CFDD4851BF31}"
#usecom global IStreamBufferRecordControl IID_IStreamBufferRecordControl "{}"
#comfunc global IStreamBufferRecordControl_Start               3 var
#comfunc global IStreamBufferRecordControl_Stop                4 int64
#comfunc global IStreamBufferRecordControl_GetRecordingStatus  5 var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。