ホーム › Devices.ImageAcquisition › IWiaVideo

IWiaVideo

COM

IIDd52920aa-db88-41f0-946c-e00dc0a19cfa継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IWiaVideo インターフェイスは、Windows Image Acquisition (WIA) サービスを使用するアプリケーションが、ストリーミングビデオデバイスから静止画像を取り込むためのメソッドを提供します。注意 WIA は、Windows Server 2003、Windows Vista 以降ではビデオデバイスをサポートしていません。これらのバージョンの Windows では、ビデオから画像を取り込むために DirectShow を使用してください。

解説(Remarks)

IWiaVideo インターフェイスは、すべての Component Object Model (COM) インターフェイスと同様に、IUnknown インターフェイスのメソッドを継承します。

IUnknown のメソッド	説明
IUnknown::QueryInterface	サポートされているインターフェイスへのポインターを返します。
IUnknown::AddRef	参照カウントをインクリメントします。
IUnknown::Release	参照カウントをデクリメントします。

メソッド 13

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

vtbl 3 HRESULT get_PreviewVisible(BOOL* pbPreviewVisible)

IWiaVideo::PreviewVisible プロパティは、ビデオの再生を親ウィンドウ内に表示するかどうかを指定します。これはビデオの WIAVIDEO_STATE には影響しません。(Get)

pbPreviewVisible

BOOL*

out

プレビュー映像が表示中かどうか(TRUE=表示)を受け取るBOOLの出力先。

vtbl 4 HRESULT put_PreviewVisible(BOOL bPreviewVisible)

IWiaVideo::PreviewVisible プロパティは、ビデオの再生を親ウィンドウ内に表示するかどうかを指定します。これはビデオの WIAVIDEO_STATE には影響しません。(Put)

bPreviewVisible

BOOL

プレビュー映像の表示有無を設定するBOOL値。TRUEで表示、FALSEで非表示。

vtbl 5 HRESULT get_ImagesDirectory(LPWSTR* pbstrImageDirectory)

IWiaVideo::ImagesDirectory プロパティは、IWiaVideo::TakePicture メソッドを呼び出したときに画像が保存されるディレクトリのフルパスを指定します。(Get)

pbstrImageDirectory

LPWSTR*

out

撮影画像の保存先ディレクトリパスを受け取る出力文字列のアドレス。

解説(Remarks)

このプロパティには、ビデオデバイスの WIA_DPV_IMAGES_DIRECTORY プロパティの値を設定してください。

vtbl 6 HRESULT put_ImagesDirectory(LPWSTR bstrImageDirectory)

IWiaVideo::ImagesDirectory プロパティは、IWiaVideo::TakePicture メソッドを呼び出したときに画像が保存されるディレクトリのフルパスを指定します。(Put)

bstrImageDirectory

LPWSTR

撮影画像の保存先ディレクトリパスを指定する文字列。

解説(Remarks)

このプロパティには、ビデオデバイスの WIA_DPV_IMAGES_DIRECTORY プロパティの値を設定してください。

vtbl 7 HRESULT CreateVideoByWiaDevID(LPWSTR bstrWiaDeviceID, HWND hwndParent, BOOL bStretchToFitParent, BOOL bAutoBeginPlayback)

IWiaVideo::CreateVideoByWiaDevID メソッドは、WIA_DIP_DEV_ID プロパティを使用してストリーミングビデオデバイスへの接続を作成します。

bstrWiaDeviceID	LPWSTR	in	ビデオデバイスの WIA_DIP_DEV_ID プロパティの値を指定します。
hwndParent	HWND	in	ストリーミングビデオを表示するウィンドウを指定します。
bStretchToFitParent	BOOL	in	ビデオの表示を親ウィンドウに合わせて引き伸ばすかどうかを指定します。親ウィンドウに合わせて引き伸ばす場合はこのパラメーターに TRUE を設定し、それ以外の場合は FALSE を設定します。
bAutoBeginPlayback	BOOL	in	このメソッドから制御が戻った直後にストリーミングビデオの再生を開始するかどうかを指定します。すぐに再生を開始する場合はこのパラメーターに TRUE を設定します。ビデオの再生開始前に IWiaVideo::Play の呼び出しを必要とする場合は FALSE を設定します。

戻り値

型: HRESULT

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

解説(Remarks)

既定では、ビデオはビデオデバイスの既定の解像度で表示されます。bStretchToFitParent に TRUE が設定されている場合、ビデオの表示はウィンドウ全体に広がります。

この関数が成功するためには、事前に IWiaVideo::ImagesDirectory プロパティを指定しておく必要があります。したがって、呼び出し元はまず "put_ImagesDirectory" を呼び出して、取り込んだ静止画像を保存するディレクトリのフルパスを指定する必要があります。

vtbl 8 HRESULT CreateVideoByDevNum(DWORD uiDeviceNumber, HWND hwndParent, BOOL bStretchToFitParent, BOOL bAutoBeginPlayback)

IWiaVideo::CreateVideoByDevNum メソッドは、Directshow の列挙から取得したデバイス番号を使用して、ストリーミングビデオデバイスへの接続を作成します。

uiDeviceNumber	DWORD	in	ビデオデバイスの Directshow デバイス番号を指定します。
hwndParent	HWND	in	ストリーミングビデオを表示するウィンドウを指定します。
bStretchToFitParent	BOOL	in	ビデオの表示を親ウィンドウに合わせて引き伸ばすかどうかを指定します。親ウィンドウに合わせて引き伸ばす場合はこのパラメーターに TRUE を設定し、それ以外の場合は FALSE を設定します。
bAutoBeginPlayback	BOOL	in	このメソッドから制御が戻った直後にストリーミングビデオの再生を開始するかどうかを指定します。すぐに再生を開始する場合はこのパラメーターに TRUE を設定します。ビデオの再生開始前に IWiaVideo::Play の呼び出しを必要とする場合は FALSE を設定します。

戻り値

型: HRESULT

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

解説(Remarks)

vtbl 9 HRESULT CreateVideoByName(LPWSTR bstrFriendlyName, HWND hwndParent, BOOL bStretchToFitParent, BOOL bAutoBeginPlayback)

IWiaVideo::CreateVideoByName メソッドは、Directshow の列挙から取得したフレンドリデバイス名を使用して、ストリーミングビデオデバイスへの接続を作成します。

bstrFriendlyName	LPWSTR	in	Directshow のデバイス列挙から取得した、ビデオデバイスのフレンドリ名を指定します。
hwndParent	HWND	in	ストリーミングビデオを表示するウィンドウを指定します。
bStretchToFitParent	BOOL	in	ビデオの表示を親ウィンドウに合わせて引き伸ばすかどうかを指定します。親ウィンドウに合わせて引き伸ばす場合はこのパラメーターに TRUE を設定し、それ以外の場合は FALSE を設定します。
bAutoBeginPlayback	BOOL	in	このメソッドから制御が戻った直後にストリーミングビデオの再生を開始するかどうかを指定します。すぐに再生を開始する場合はこのパラメーターに TRUE を設定します。ビデオの再生開始前に IWiaVideo::Play の呼び出しを必要とする場合は FALSE を設定します。

戻り値

型: HRESULT

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

解説(Remarks)

vtbl 10 HRESULT DestroyVideo()

IWiaVideo::DestroyVideo メソッドは、ストリーミングビデオを終了します。ビデオの再生を再開するには、アプリケーションは IWiaVideo の CreateVideo 系メソッドのいずれかを再度呼び出す必要があります。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、IWiaVideo::CreateVideoByWiaDevID、IWiaVideo::CreateVideoByDevNum、または IWiaVideo::CreateVideoByName の呼び出しが成功した後にのみ呼び出してください。

vtbl 11 HRESULT Play()

ストリーミングビデオの再生を開始します。

戻り値

型: HRESULT

このメソッドが成功した場合、またはビデオが既に再生中の場合、このメソッドは S_OK を返します。メソッドが失敗した場合は、標準の COM エラーコードを返します。

解説(Remarks)

vtbl 12 HRESULT Pause()

IWiaVideo::Pause メソッドは、ビデオの再生を一時停止します。

戻り値

型: HRESULT

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

解説(Remarks)

vtbl 13 HRESULT TakePicture(LPWSTR* pbstrNewImageFilename)

IWiaVideo::TakePicture メソッドは、ビデオストリームから静止画像を抽出し、その画像を JPEG ファイルとして保存します。

pbstrNewImageFilename

LPWSTR*

out

このメソッドが作成する JPEG ファイルのフルパスとファイル名を受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

画像ファイルが保存されるパスおよびディレクトリは、IWiaVideo::ImagesDirectory プロパティによって指定されます。

vtbl 14 HRESULT ResizeVideo(BOOL bStretchToFitParent)

IWiaVideo::ResizeVideo メソッドは、親ウィンドウ内に収まる最大のサポート解像度に、ビデオ再生のサイズを変更します。親ウィンドウが移動またはサイズ変更されるたびに、このメソッドを呼び出してください。

bStretchToFitParent

BOOL

ビデオの再生を親ウィンドウ全体に広がるように引き伸ばすかどうかを指定します。

戻り値

型: HRESULT

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

解説(Remarks)

既定では、ビデオは親ウィンドウよりも小さいサポート解像度で表示されます。bStretchToFitParent に TRUE が設定されている場合、ビデオの表示はウィンドウ全体に広がります。

vtbl 15 HRESULT GetCurrentState(WIAVIDEO_STATE* pState)

IWiaVideo::GetCurrentState メソッドは、ビデオストリームの状態を WIAVIDEO_STATE 列挙型のメンバーとして返します。

pState

WIAVIDEO_STATE*

out

ビデオストリームの現在の状態を示す WIAVIDEO_STATE 列挙型のメンバーです。

戻り値

型: HRESULT

このメソッドが成功した場合は 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_IWiaVideo "{D52920AA-DB88-41F0-946C-E00DC0A19CFA}"
#usecom global IWiaVideo IID_IWiaVideo "{3908C3CD-4478-4536-AF2F-10C25D4EF89A}"
#comfunc global IWiaVideo_get_PreviewVisible     3 var
#comfunc global IWiaVideo_put_PreviewVisible     4 int
#comfunc global IWiaVideo_get_ImagesDirectory    5 var
#comfunc global IWiaVideo_put_ImagesDirectory    6 wstr
#comfunc global IWiaVideo_CreateVideoByWiaDevID  7 wstr,sptr,int,int
#comfunc global IWiaVideo_CreateVideoByDevNum    8 int,sptr,int,int
#comfunc global IWiaVideo_CreateVideoByName      9 wstr,sptr,int,int
#comfunc global IWiaVideo_DestroyVideo           10
#comfunc global IWiaVideo_Play                   11
#comfunc global IWiaVideo_Pause                  12
#comfunc global IWiaVideo_TakePicture            13 var
#comfunc global IWiaVideo_ResizeVideo            14 int
#comfunc global IWiaVideo_GetCurrentState        15 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWiaVideo "{D52920AA-DB88-41F0-946C-E00DC0A19CFA}"
#usecom global IWiaVideo IID_IWiaVideo "{3908C3CD-4478-4536-AF2F-10C25D4EF89A}"
#comfunc global IWiaVideo_get_PreviewVisible     3 sptr
#comfunc global IWiaVideo_put_PreviewVisible     4 int
#comfunc global IWiaVideo_get_ImagesDirectory    5 sptr
#comfunc global IWiaVideo_put_ImagesDirectory    6 wstr
#comfunc global IWiaVideo_CreateVideoByWiaDevID  7 wstr,sptr,int,int
#comfunc global IWiaVideo_CreateVideoByDevNum    8 int,sptr,int,int
#comfunc global IWiaVideo_CreateVideoByName      9 wstr,sptr,int,int
#comfunc global IWiaVideo_DestroyVideo           10
#comfunc global IWiaVideo_Play                   11
#comfunc global IWiaVideo_Pause                  12
#comfunc global IWiaVideo_TakePicture            13 sptr
#comfunc global IWiaVideo_ResizeVideo            14 int
#comfunc global IWiaVideo_GetCurrentState        15 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。