ホーム › Media.MediaFoundation › IMFCaptureEngine

IMFCaptureEngine

COM

📘 Microsoft Learn (日本語) · English

IIDa6bba433-176b-48b2-b375-53aa03473207継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

1台以上のキャプチャデバイスを制御します。

解説(Remarks)

IMFCaptureEngine は 1 パス CBR エンコードのみをサポートします。

メソッド 8

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

vtbl 3 HRESULT Initialize(IMFCaptureEngineOnEventCallback* pEventCallback, IMFAttributes* pAttributes, IUnknown* pAudioSource, IUnknown* pVideoSource)

キャプチャエンジンを初期化します。

pEventCallback	IMFCaptureEngineOnEventCallback*	in	IMFCaptureEngineOnEventCallback インターフェイスへのポインター。呼び出し側はこのインターフェイスを実装する必要があります。キャプチャエンジンはこのインターフェイスを使用して、非同期イベントを呼び出し側に送信します。
pAttributes	IMFAttributes*	inoptional	IMFAttributes インターフェイスへのポインター。このパラメーターは NULL でもかまいません。このパラメーターを使用してキャプチャエンジンを構成できます。MFCreateAttributes を呼び出して属性ストアを作成し、次の属性のいずれかを設定します。 MF_CAPTURE_ENGINE_D3D_MANAGER MF_CAPTURE_ENGINE_DISABLE_DXVA MF_CAPTURE_ENGINE_DISABLE_HARDWARE_TRANSFORMS MF_CAPTURE_ENGINE_ENCODER_MFT_FIELDOFUSE_UNLOCK_Attribute MF_CAPTURE_ENGINE_EVENT_GENERATOR_GUID MF_CAPTURE_ENGINE_EVENT_STREAM_INDEX MF_CAPTURE_ENGINE_MEDIASOURCE_CONFIG MF_CAPTURE_ENGINE_RECORD_SINK_AUDIO_MAX_PROCESSED_SAMPLES MF_CAPTURE_ENGINE_RECORD_SINK_AUDIO_MAX_UNPROCESSED_SAMPLES MF_CAPTURE_ENGINE_RECORD_SINK_VIDEO_MAX_PROCESSED_SAMPLES MF_CAPTURE_ENGINE_RECORD_SINK_VIDEO_MAX_UNPROCESSED_SAMPLES MF_CAPTURE_ENGINE_USE_AUDIO_DEVICE_ONLY MF_CAPTURE_ENGINE_USE_VIDEO_DEVICE_ONLY
pAudioSource	IUnknown*	inoptional	オーディオキャプチャデバイスを指定する IUnknown ポインター。このパラメーターは NULL でもかまいません。 pAttributes で MF_CAPTURE_ENGINE_USE_VIDEO_DEVICE_ONLY 属性を TRUE に設定した場合、キャプチャエンジンはオーディオデバイスを使用せず、pAudioSource パラメーターは無視されます。それ以外の場合、pAudioSource が NULL のときは、キャプチャエンジンは pVideoSource で指定されたビデオカメラに内蔵されているマイクを選択します。ビデオカメラにマイクがない場合、キャプチャエンジンはシステム上のオーディオキャプチャデバイスを列挙し、最初のものを選択します。既定のオーディオデバイスを上書きするには、pAudioSource にそのデバイスの IMFMediaSource または IMFActivate ポインターを設定します。詳細については、Audio/Video Capture in Media Foundation を参照してください。
pVideoSource	IUnknown*	inoptional	ビデオキャプチャデバイスを指定する IUnknown ポインター。このパラメーターは NULL でもかまいません。 pAttributes で MF_CAPTURE_ENGINE_USE_AUDIO_DEVICE_ONLY 属性を TRUE に設定した場合、キャプチャエンジンはビデオデバイスを使用せず、pVideoSource パラメーターは無視されます。それ以外の場合、pVideoSource が NULL のときは、キャプチャエンジンはシステム上のビデオキャプチャデバイスを列挙し、最初のものを選択します。既定のビデオデバイスを上書きするには、pVideoSource にそのデバイスの IMFMediaSource または IMFActivate ポインターを設定します。詳細については、Enumerating Video Capture Devices を参照してください。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻りコード	説明
S_OK	成功しました。
MF_E_INVALIDREQUEST	Initialize メソッドはすでに呼び出されています。
MF_E_NO_CAPTURE_DEVICES_AVAILABLE	利用可能なキャプチャデバイスがありません。
MF_E_UNSUPPORTED_CAPTURE_DEVICE_PRESENT	サポートされていないキャプチャデバイスがシステムに存在します。このエラーは、pVideoSource パラメーターに NULL を指定してシステムにキャプチャデバイスを選択させ、かつサポートされているキャプチャデバイスがまだ接続されていない場合にのみ返されます。このエラーが返された場合、アプリは一般的な失敗メッセージではなく、サポートされていないキャプチャデバイスに関する具体的なメッセージをユーザーに表示することが推奨されます。

解説(Remarks)

キャプチャエンジンを使用する前に、このメソッドを一度呼び出す必要があります。このメソッドを 2 回目に呼び出すと MF_E_INVALIDREQUEST が返されます。

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_INITIALIZED イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

vtbl 4 HRESULT StartPreview()

プレビューを開始します。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻りコード	説明
S_OK	成功しました。
MF_E_INVALIDREQUEST	プレビューシンクが初期化されていません。

解説(Remarks)

このメソッドを呼び出す前に、IMFCaptureSink::AddStream を呼び出してプレビューシンクを構成してください。プレビューシンクへのポインターを取得するには、IMFCaptureEngine::GetSink を呼び出します。

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_PREVIEW_STARTED イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

プレビューシンクの構成後は、IMFCaptureEngine::StopPreview および IMFCaptureEngine::StartPreview を呼び出すことで、プレビューの停止と開始を行えます。

vtbl 5 HRESULT StopPreview()

プレビューを停止します。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻りコード	説明
S_OK	成功しました。
MF_E_INVALIDREQUEST	キャプチャエンジンは現在プレビューを行っていません。

解説(Remarks)

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_PREVIEW_STOPPED イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

vtbl 6 HRESULT StartRecord()

オーディオおよび/またはビデオのファイルへの録画・録音を開始します。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻りコード	説明
S_OK	成功しました。
MF_E_INVALIDREQUEST	録画シンクが初期化されていません。

解説(Remarks)

このメソッドを呼び出す前に、IMFCaptureSink::AddStream を呼び出して録画シンクを構成してください。録画シンクへのポインターを取得するには、IMFCaptureEngine::GetSink を呼び出します。

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_RECORD_STARTED イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

録画を停止するには、IMFCaptureEngine::StopRecord を呼び出します。

vtbl 7 HRESULT StopRecord(BOOL bFinalize, BOOL bFlushUnprocessedSamples)

録画を停止します。

bFinalize	BOOL	in	出力ファイルをファイナライズするかどうかを指定するブール値。有効な出力ファイルを作成するには TRUE を指定します。録画を中断して出力ファイルを破棄する場合にのみ FALSE を指定します。値が FALSE の場合、操作はより速く完了しますが、ファイルは再生できなくなります。
bFlushUnprocessedSamples	BOOL	in	エンコード待ちの未処理サンプルをフラッシュするかどうかを指定するブール値。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_RECORD_STOPPED イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

vtbl 8 HRESULT TakePhoto()

ビデオストリームから静止画像をキャプチャします。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを呼び出す前に、IMFCaptureSink::AddStream を呼び出してフォトシンクを構成してください。フォトシンクへのポインターを取得するには、IMFCaptureEngine::GetSink を呼び出します。

このメソッドは非同期です。メソッドが成功コードを返した場合、呼び出し側は IMFCaptureEngineOnEventCallback::OnEvent メソッドを通じて MF_CAPTURE_ENGINE_PHOTO_TAKEN イベントを受け取ります。この操作は、メソッドが成功した後に非同期に失敗する可能性があります。その場合、エラーコードは OnEvent メソッドを通じて伝えられます。

vtbl 9 HRESULT GetSink(MF_CAPTURE_ENGINE_SINK_TYPE mfCaptureEngineSinkType, IMFCaptureSink** ppSink)

キャプチャシンクオブジェクトの 1 つへのポインターを取得します。

mfCaptureEngineSinkType	MF_CAPTURE_ENGINE_SINK_TYPE	in	取得するキャプチャシンクを指定する MF_CAPTURE_ENGINE_SINK_TYPE 値。
ppSink	IMFCaptureSink**	out	IMFCaptureSink インターフェイスへのポインターを受け取ります。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

このメソッドは次のいずれかの値を返すことができます。

戻りコード	説明
S_OK	成功しました。
E_INVALIDARG	引数が無効です。

vtbl 10 HRESULT GetSource(IMFCaptureSource** ppSource)

キャプチャソースオブジェクトへのポインターを取得します。

ppSource

IMFCaptureSource**

out

IMFCaptureSource インターフェイスへのポインターを受け取ります。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMFCaptureEngine "{A6BBA433-176B-48B2-B375-53AA03473207}"
#usecom global IMFCaptureEngine IID_IMFCaptureEngine "{}"
#comfunc global IMFCaptureEngine_Initialize    3 sptr,sptr,sptr,sptr
#comfunc global IMFCaptureEngine_StartPreview  4
#comfunc global IMFCaptureEngine_StopPreview   5
#comfunc global IMFCaptureEngine_StartRecord   6
#comfunc global IMFCaptureEngine_StopRecord    7 int,int
#comfunc global IMFCaptureEngine_TakePhoto     8
#comfunc global IMFCaptureEngine_GetSink       9 int,sptr
#comfunc global IMFCaptureEngine_GetSource     10 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。