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

ITuningSpace

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

公式ドキュメント

ITuningSpace インターフェイスは、すべてのネットワーク固有のチューニングスペースに共通する機能を提供します。

解説(Remarks)

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

メソッド 19

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

vtbl 7 HRESULT get_UniqueName(LPWSTR* Name)

get_UniqueName メソッドは、チューニングスペースの一意な名前を取得します。

NameLPWSTR*out一意な名前を受け取る変数へのポインター。

戻り値

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

解説(Remarks)

呼び出し側は、返された BSTR を SysFreeString を呼び出して解放する必要があります。

vtbl 8 HRESULT put_UniqueName(LPWSTR Name)

put_UniqueName メソッドは、チューニングスペースに一意な名前を設定します。

NameLPWSTRin一意な名前を指定する BSTR 型の変数。

戻り値

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

解説(Remarks)

新しいチューニングスペースを System Tuning Spaces コレクションに追加しようとする場合、このプロパティはコレクション内で一意でなければなりません。詳細については、ITuningSpaceContainer::Add を参照してください。

vtbl 9 HRESULT get_FriendlyName(LPWSTR* Name)

get_FriendlyName メソッドは、チューニングスペースのローカライズされたユーザーフレンドリーな名前を取得します。

NameLPWSTR*outユーザーフレンドリーな名前を受け取る変数へのポインター。

戻り値

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

解説(Remarks)

呼び出し側は、返された BSTR を SysFreeString を呼び出して解放する必要があります。

vtbl 10 HRESULT put_FriendlyName(LPWSTR Name)

put_FriendlyName メソッドは、チューニングスペースのローカライズされたユーザーフレンドリーな名前を設定します。

NameLPWSTRinユーザーフレンドリーな名前を指定します。

戻り値

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

vtbl 11 HRESULT get_CLSID(LPWSTR* SpaceCLSID)

get_CLSID メソッドは、チューニングスペースの CLSID を BSTR として取得します。

SpaceCLSIDLPWSTR*outチューニングスペースの CLSID の文字列表現を受け取る変数へのポインター。

戻り値

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

解説(Remarks)

このメソッドは、IPersist::GetClassID メソッドへのスクリプトアクセスを提供します。

返される CLSID は、このチューニングスペースを実装する COM オブジェクトを表します。ただし、同じオブジェクトが複数のチューニングスペースを実装する場合があるため、CLSID がこのチューニングスペースに対して一意であることは保証されません。

vtbl 12 HRESULT get_NetworkType(LPWSTR* NetworkTypeGuid)

get_NetworkType メソッドは、チューニングスペースのネットワークタイプを BSTR として取得します。

NetworkTypeGuidLPWSTR*outネットワークタイプの GUID を含む文字列を受け取る変数へのポインター。

戻り値

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

解説(Remarks)

呼び出し側は、返された BSTR を SysFreeString を呼び出して解放する必要があります。

vtbl 13 HRESULT put_NetworkType(LPWSTR NetworkTypeGuid)

put_NetworkType メソッドは、チューニングスペースのネットワークタイプを BSTR として指定します。

NetworkTypeGuidLPWSTRinネットワークタイプの GUID の文字列表現を含みます。

戻り値

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

vtbl 14 HRESULT get__NetworkType(GUID* NetworkTypeGuid)

get_NetworkType メソッドは、このチューニングスペースのネットワークタイプを取得します。

NetworkTypeGuidGUID*outネットワークタイプの GUID を受け取る変数へのポインター。この GUID は、チューニングスペースの Network Provider の CLSID に対応します。一部のチューニングスペースでは、ネットワークタイプは GUID_NULL となり、これはチューニングスペースが Network Provider フィルターを使用しないことを意味します。

戻り値

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

vtbl 15 HRESULT put__NetworkType(GUID* NetworkTypeGuid)

put_NetworkType メソッドは、チューニングスペースのネットワークタイプを指定します。

NetworkTypeGuidGUID*inネットワークタイプの GUID を指定します。この GUID は、チューニングスペースの Network Provider の CLSID に対応します。値 GUID_NULL は、チューニングスペースが Network Provider フィルターを使用しないことを意味します。

戻り値

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

vtbl 16 HRESULT CreateTuneRequest(ITuneRequest** TuneRequest)

CreateTuneRequest メソッドは、空の (初期化されていない) チューン要求を作成します。

TuneRequestITuneRequest**out新しいチューン要求オブジェクトの ITuneRequest インターフェイスへのポインターを受け取る変数のアドレス。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

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

解説(Remarks)

返された ITuneRequest ポインターに対して、派生インターフェイスをクエリできます。詳細については、個々のチューニングスペースオブジェクトのリファレンスページを参照してください。これらは Tuning Model Objects のトピックに一覧されています。

vtbl 17 HRESULT EnumCategoryGUIDs(IEnumGUID** ppEnum)

現在実装されていません。

ppEnumIEnumGUID**out返される列挙オブジェクトを受け取る IEnumGUID インターフェイスポインターのアドレス。

戻り値

E_NOTIMPL を返します。

解説(Remarks)

このメソッドはオートメーション言語からは隠されています。

vtbl 18 HRESULT EnumDeviceMonikers(IEnumMoniker** ppEnum)

EnumDeviceMonikers メソッドは、このチューニングスペースをサポートするチューナーフィルターを表すデバイスモニカーの列挙子を作成します。

ppEnumIEnumMoniker**out返される列挙オブジェクトを受け取る IEnumMoniker インターフェイスポインターのアドレス。

戻り値

E_NOTIMPL を返します。

解説(Remarks)

このメソッドはオートメーション言語からは隠されています。

vtbl 19 HRESULT get_DefaultPreferredComponentTypes(IComponentTypes** ComponentTypes)

get_DefaultPreferredComponentTypes メソッドは、このチューニングスペースの既定の優先コンポーネントタイプの一覧を返します。

ComponentTypesIComponentTypes**outIComponentTypes インターフェイスポインターを受け取る変数のアドレス。このインターフェイスを使用してコンポーネントタイプを列挙します。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

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

解説(Remarks)

コンポーネントとは、番組内のストリームです。優先コンポーネントタイプの例としては、英語の音声ストリームが挙げられます。複数のコンポーネントが利用可能な場合、チューナーは優先されるコンポーネントを最初に再生しようとします。

チューニングスペースに既定の優先タイプが存在しない場合、このメソッドは成功しますが、ppComponentTypes パラメーターに値 NULL を返します。ポインターを逆参照する前に、NULL 値かどうかを確認してください。

vtbl 20 HRESULT put_DefaultPreferredComponentTypes(IComponentTypes* NewComponentTypes)

put_DefaultPreferredComponentTypes メソッドは、このチューニングスペースの既定の優先コンポーネントタイプを指定します。

NewComponentTypesIComponentTypes*inコンポーネントタイプコレクションの IComponentTypes インターフェイスへのポインター。

戻り値

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

vtbl 21 HRESULT get_FrequencyMapping(LPWSTR* pMapping)

get_FrequencyMapping メソッドは、put_FrequencyMapping の呼び出しによって Network Provider が以前に作成した周波数マッピングを取得します。

pMappingLPWSTR*outNetwork Provider フィルターによって作成された周波数マッピングを受け取る変数へのポインター。

戻り値

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

解説(Remarks)

返される BSTR はバイナリの blob として扱われます。これは埋め込まれた NULL 値を含むことが想定され、BDA Network Provider によって内部的にフォーマットされている場合があります。

呼び出し側は、返された BSTR を SysFreeString を呼び出して解放する必要があります。

vtbl 22 HRESULT put_FrequencyMapping(LPWSTR Mapping)

put_FrequencyMapping メソッドは、周波数/チャンネルマップ、周波数/トランスポンダーマップ、またはチューニングスペースに適したキャリア周波数から周波数識別子へのその他のマッピングを作成します。

MappingLPWSTRin周波数マッピングを含む BSTR。

戻り値

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

解説(Remarks)

このメソッドは、周波数マッピングを含む文字列を格納するために Network Provider によって使用されます。

vtbl 23 HRESULT get_DefaultLocator(ILocator** LocatorVal)

get_DefaultLocator メソッドは、このチューニングスペースの既定のロケーターを取得します。

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

戻り値

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

解説(Remarks)

チューニングスペースには既定のロケーターがない場合があります。必要に応じてチューニングスペースの既定のロケーターを提供するのは、アプリケーションの責任です。

チューニングスペースに既定のロケーターがない場合、このメソッドは成功しますが、ppLocatorVal パラメーターに値 NULL を返します。ポインターを逆参照する前に、NULL 値かどうかを確認してください。

vtbl 24 HRESULT put_DefaultLocator(ILocator* LocatorVal)

put_DefaultLocator メソッドは、このチューニングスペースの既定のロケーターを設定します。

LocatorValILocator*inロケーターオブジェクトの ILocator インターフェイスへのポインター。

戻り値

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

解説(Remarks)

既定のロケーターの詳細については、ITuningSpace::get_DefaultLocator を参照してください。

DVB チューニングスペースの場合、チューニングスペースのシステムタイプ (ケーブル、地上波、または衛星) がロケーターオブジェクトと一致する必要があります。一致しない場合、メソッドは DISP_E_TYPEMISMATCH を返します。詳細については、IDVBTuningSpace::put_SystemType を参照してください。

vtbl 25 HRESULT Clone(ITuningSpace** NewTS)

Clone メソッドは、チューニングスペースの新しいコピーを作成します。

NewTSITuningSpace**out新しいチューニングスペースオブジェクトの ITuningSpace インターフェイスへのポインターを受け取ります。呼び出し側はこのインターフェイスを解放する必要があります。

戻り値

成功した場合は 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_ITuningSpace "{061C6E30-E622-11D2-9493-00C04F72D980}"
#usecom global ITuningSpace IID_ITuningSpace "{5FFDC5E6-B83A-4B55-B6E8-C69E765FE9DB}"
#comfunc global ITuningSpace_get_UniqueName                      7 var
#comfunc global ITuningSpace_put_UniqueName                      8 wstr
#comfunc global ITuningSpace_get_FriendlyName                    9 var
#comfunc global ITuningSpace_put_FriendlyName                    10 wstr
#comfunc global ITuningSpace_get_CLSID                           11 var
#comfunc global ITuningSpace_get_NetworkType                     12 var
#comfunc global ITuningSpace_put_NetworkType                     13 wstr
#comfunc global ITuningSpace_get__NetworkType                    14 var
#comfunc global ITuningSpace_put__NetworkType                    15 var
#comfunc global ITuningSpace_CreateTuneRequest                   16 sptr
#comfunc global ITuningSpace_EnumCategoryGUIDs                   17 sptr
#comfunc global ITuningSpace_EnumDeviceMonikers                  18 sptr
#comfunc global ITuningSpace_get_DefaultPreferredComponentTypes  19 sptr
#comfunc global ITuningSpace_put_DefaultPreferredComponentTypes  20 sptr
#comfunc global ITuningSpace_get_FrequencyMapping                21 var
#comfunc global ITuningSpace_put_FrequencyMapping                22 wstr
#comfunc global ITuningSpace_get_DefaultLocator                  23 sptr
#comfunc global ITuningSpace_put_DefaultLocator                  24 sptr
#comfunc global ITuningSpace_Clone                               25 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。