ホーム › Media.MediaFoundation › IMFSensorGroup

IMFSensorGroup

COM

📘 Microsoft Learn (日本語) · English

IID4110243a-9757-461f-89f1-f22345bcab4e継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IMFMediaSource を作成できるセンサーデバイスのグループを表します。

メソッド 8

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

vtbl 3 HRESULT GetSymbolicLink(LPWSTR SymbolicLink, INT cchSymbolicLink, INT* pcchWritten)

センサーグループのシンボリックリンク名を取得します。

SymbolicLink	LPWSTR	out	シンボリックリンク名が書き込まれる cchSymbolicLink 文字分のバッファ。バッファは null 終端文字分も含めて十分な大きさが必要です。
cchSymbolicLink	INT	in	SymbolicLink バッファで利用可能な文字数。
pcchWritten	INT*	out	SymbolicLink に書き込まれた文字数を格納する出力パラメーター。これには null 終端文字が含まれます。SymbolicLink が null かつ cchSymbolicLink が 0 の場合、pcchWritten にはシンボリックリンク名を格納するために必要な文字数(null 終端文字を含む)が格納されます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
ERROR_INSUFFICIENT_BUFFER	SymbolicLink パラメーターで指定されたバッファが、null 終端文字を含めたシンボリックリンク名を格納するのに十分な大きさではありません。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

vtbl 4 HRESULT GetFlags(ULONGLONG* pFlags)

センサーグループに設定されているフラグを取得します。

pFlags

ULONGLONG*

out

センサーグループに設定されているフラグ

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

現在、Sensor Group に対して定義されているフラグはありません。

vtbl 5 HRESULT GetSensorGroupAttributes(IMFAttributes** ppAttributes)

センサーグループの IMFAttributes を取得します。返されるオブジェクトは内部の属性ストアへのライブ参照です。

ppAttributes

IMFAttributes**

out

センサーグループの内部属性ストアを表す IMFAttributes インターフェイス。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	ppAttributes パラメーターが null です。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

呼び出し元は、この属性ストアを任意で使用して、センサーグループに設定された属性を照会したり、センサーグループに属性を変更・追加したりできます。この属性セットへの変更は永続化されず、その IMFSensorGroup のインスタンスに対してのみ有効です。

この属性ストアは、IMFSensorGroup::CreateMediaSource メソッドを使用して作成できる IMFMediaSource に対して、実行時属性を追加するために使用できます。

vtbl 6 HRESULT GetSensorDeviceCount(DWORD* pdwCount)

センサーグループによって仮想化されているデバイスの数を取得します。

pdwCount

DWORD*

out

センサーグループ内のデバイス数。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pdwCount パラメーターが null です。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

ここでいう「デバイス」とは、物理デバイス、カスタムメディアソース、またはフレームプロバイダーを指す場合があります。

vtbl 7 HRESULT GetSensorDevice(DWORD dwIndex, IMFSensorDevice** ppDevice)

センサーグループ内のデバイスに対応する IMFSensorDevice を取得します。

dwIndex	DWORD	in	取得するデバイスの 0 始まりのインデックス。インデックスは 0 から GetSensorDeviceCount が返す値 - 1 の範囲でなければなりません。
ppDevice	IMFSensorDevice**	out	呼び出しが成功した場合、ppDevice には取得されたセンサーデバイスが格納されます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	ppDevice パラメーターが null です。
MF_E_INVALID_INDEX	dwIndex パラメーターが有効な範囲にありません。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

ここでいう「デバイス」とは、物理デバイス、カスタムメディアソース、またはフレームプロバイダーを指す場合があります。

vtbl 8 HRESULT SetDefaultSensorDeviceIndex(DWORD dwIndex)

センサーグループ内のいずれかのデバイスを既定のデバイスとして構成します。

dwIndex

DWORD

既定として設定するデバイスの 0 始まりのインデックス。インデックスは 0 から GetSensorDeviceCount が返す値 - 1 の範囲でなければなりません。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
MF_E_INVALID_INDEX	dwIndex パラメーターが有効な範囲にありません。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

ここでいう「デバイス」とは、物理デバイス、カスタムメディアソース、またはフレームプロバイダーを指す場合があります。

このメソッドが呼び出されない場合、Sensor Group 内の最初のデバイス(つまりインデックス 0 のデバイス)が使用されます。

vtbl 9 HRESULT GetDefaultSensorDeviceIndex(DWORD* pdwIndex)

センサーグループ内の既定のデバイスのインデックスを取得します。

pdwIndex

DWORD*

out

呼び出しが成功した場合、pdwIndex は既定のデバイスのインデックスを受け取ります。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pdwIndex パラメーターが null です。
MF_E_NOT_INITIALIZED	センサーグループが初期化されていません。

解説(Remarks)

ここでいう「デバイス」とは、物理デバイス、カスタムメディアソース、またはフレームプロバイダーを指す場合があります。

この SetDefaultSensorDevice が呼び出されていない場合、Sensor Group 内の最初のデバイス(つまりインデックス 0)が返されます。

vtbl 10 HRESULT CreateMediaSource(IMFMediaSource** ppSource)

センサーグループを仮想化する IMFMediaSource を作成します。

ppSource

IMFMediaSource**

out

作成されたメディアソースへのポインターを受け取ります。

戻り値

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

戻り値コード	説明
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_IMFSensorGroup "{4110243A-9757-461F-89F1-F22345BCAB4E}"
#usecom global IMFSensorGroup IID_IMFSensorGroup "{}"
#comfunc global IMFSensorGroup_GetSymbolicLink              3 var,int,var
#comfunc global IMFSensorGroup_GetFlags                     4 var
#comfunc global IMFSensorGroup_GetSensorGroupAttributes     5 sptr
#comfunc global IMFSensorGroup_GetSensorDeviceCount         6 var
#comfunc global IMFSensorGroup_GetSensorDevice              7 int,sptr
#comfunc global IMFSensorGroup_SetDefaultSensorDeviceIndex  8 int
#comfunc global IMFSensorGroup_GetDefaultSensorDeviceIndex  9 var
#comfunc global IMFSensorGroup_CreateMediaSource            10 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IMFSensorGroup "{4110243A-9757-461F-89F1-F22345BCAB4E}"
#usecom global IMFSensorGroup IID_IMFSensorGroup "{}"
#comfunc global IMFSensorGroup_GetSymbolicLink              3 sptr,int,sptr
#comfunc global IMFSensorGroup_GetFlags                     4 sptr
#comfunc global IMFSensorGroup_GetSensorGroupAttributes     5 sptr
#comfunc global IMFSensorGroup_GetSensorDeviceCount         6 sptr
#comfunc global IMFSensorGroup_GetSensorDevice              7 int,sptr
#comfunc global IMFSensorGroup_SetDefaultSensorDeviceIndex  8 int
#comfunc global IMFSensorGroup_GetDefaultSensorDeviceIndex  9 sptr
#comfunc global IMFSensorGroup_CreateMediaSource            10 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。