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

ILocator

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID286d7f89-760c-4f89-80c4-66841d2507aa継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ILocator インターフェイスは、チューニングスペースに関するチューニング情報を保持する Locator オブジェクトに、(IATSCLocator などの派生インターフェイスを通じて)実装されます。

解説(Remarks)

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

メソッド 15

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_CarrierFrequency(INT* Frequency)

get_CarrierFrequency メソッドは、RF 信号の周波数を取得します。

FrequencyINT*out周波数をキロヘルツ (kHz) 単位で受け取ります。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 8 HRESULT put_CarrierFrequency(INT Frequency)

put_CarrierFrequency メソッドは、RF 信号の周波数を設定します。

FrequencyINTin周波数(キロヘルツ (kHz) 単位)。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 9 HRESULT get_InnerFEC(FECMethod* FEC)

get_InnerFEC メソッドは、使用されている内部 FEC の種類を取得します。

FECFECMethod*out内部 FEC の種類を受け取る FECMethod 型の変数へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 10 HRESULT put_InnerFEC(FECMethod FEC)

put_InnerFEC メソッドは、使用する内部 FEC の種類を設定します。

FECFECMethodin内部 FEC を指定します。このパラメーターは FECMethod 型の値です。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 11 HRESULT get_InnerFECRate(BinaryConvolutionCodeRate* FEC)

get_InnerFECRate メソッドは、内部 FEC レートを取得します。

FECBinaryConvolutionCodeRate*out内部 FEC レートを受け取る BinaryConvolutionCodeRate 型の変数へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 12 HRESULT put_InnerFECRate(BinaryConvolutionCodeRate FEC)

put_InnerFECRate メソッドは、内部 FEC レートを設定します。

FECBinaryConvolutionCodeRatein内部 FEC レートを指定します。このパラメーターは BinaryConvolutionCodeRate 型の値です。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 13 HRESULT get_OuterFEC(FECMethod* FEC)

get_OuterFEC メソッドは、使用されている外部 FEC の種類を取得します。

FECFECMethod*out外部 FEC の種類を受け取る FECMethod 型の変数へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 14 HRESULT put_OuterFEC(FECMethod FEC)

put_OuterFEC メソッドは、使用する外部 FEC の種類を設定します。

FECFECMethodin外部 FEC を指定します。このパラメーターは FECMethod 型の値です。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 15 HRESULT get_OuterFECRate(BinaryConvolutionCodeRate* FEC)

get_OuterFECRate メソッドは、外部 FEC レートを取得します。

FECBinaryConvolutionCodeRate*out外部 FEC レートを受け取る BinaryConvolutionCodeRate 型の変数へのポインター。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 16 HRESULT put_OuterFECRate(BinaryConvolutionCodeRate FEC)

put_OuterFECRate メソッドは、外部 FEC レートを設定します。

FECBinaryConvolutionCodeRatein外部 FEC レートを指定します。このパラメーターは BinaryConvolutionCodeRate 型の値です。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 17 HRESULT get_Modulation(ModulationType* Modulation)

get_Modulation メソッドは、変調方式を取得します。

ModulationModulationType*outModulationType 列挙体のメンバーとして、変調方式を受け取ります。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

解説(Remarks)

ModulationType の定義については、put_Modulation を参照してください。

vtbl 18 HRESULT put_Modulation(ModulationType Modulation)

put_Modulation メソッドは、変調方式を設定します。

ModulationModulationTypeinModulationType 列挙体のメンバーとして指定する変調方式。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 19 HRESULT get_SymbolRate(INT* Rate)

get_SymbolRate メソッドは、QPSK シンボルレートを取得します。

RateINT*outQPSK シンボルレートを受け取ります。レートはシンボル毎秒で表されます。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 20 HRESULT put_SymbolRate(INT Rate)

put_SymbolRate メソッドは、QPSK シンボルレートを設定します。

RateINTinQPSK シンボルレートを指定します。レートはシンボル毎秒で表されます。

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

vtbl 21 HRESULT Clone(ILocator** NewLocator)

Clone メソッドは、Locator のコピーを作成します。

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

戻り値

成功した場合は S_OK を返します。メソッドが失敗した場合、標準の COM IErrorInfo インターフェイスを使用してエラー情報を取得できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ILocator "{286D7F89-760C-4F89-80C4-66841D2507AA}"
#usecom global ILocator IID_ILocator "{0888C883-AC4F-4943-B516-2C38D9B34562}"
#comfunc global ILocator_get_CarrierFrequency  7 var
#comfunc global ILocator_put_CarrierFrequency  8 int
#comfunc global ILocator_get_InnerFEC          9 var
#comfunc global ILocator_put_InnerFEC          10 int
#comfunc global ILocator_get_InnerFECRate      11 var
#comfunc global ILocator_put_InnerFECRate      12 int
#comfunc global ILocator_get_OuterFEC          13 var
#comfunc global ILocator_put_OuterFEC          14 int
#comfunc global ILocator_get_OuterFECRate      15 var
#comfunc global ILocator_put_OuterFECRate      16 int
#comfunc global ILocator_get_Modulation        17 var
#comfunc global ILocator_put_Modulation        18 int
#comfunc global ILocator_get_SymbolRate        19 var
#comfunc global ILocator_put_SymbolRate        20 int
#comfunc global ILocator_Clone                 21 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。