Microsoft DirectX 8.0

ITuningSpace インターフェイス

ITuningSpace インターフェイスは、ネットワーク固有のチューニング空間すべてに共通の機能を提供する基底クラスである。チューニング空間コンテナでは、ITuningSpace のみを公開するオブジェクトのインスタンスを重複して作成することはなく、必ず、ITuningSpace から派生する何らかのインターフェイス (IASTCTuningSpace など) をサポートするオブジェクトのインスタンスを作成する。

メソッド名説明
get_UniqueNameチューニング空間の固有の名称を取得する。固有の名称は略称か GUID である。
put_UniqueNameチューニング空間の固有の名称を設定する。固有の名称は略称か GUID である。
get_FriendlyNameチューニング空間のローカライズされたフレンドリ名を取得する。
put_FriendlyNameチューニング空間のローカライズされたフレンドリ名を設定する。
get_CLSIDチューニング空間の CLSID を BSTR として取得する。
put_NetworkTypeこのチューニング空間のネットワーク タイプを BSTR として設定する。
get__NetworkTypeチューニング空間のネットワーク タイプを GUID として取得する。
put__NetworkTypeこのチューニング空間のネットワーク タイプを REFCLSID として設定する。
get_NetworkTypeチューニング空間のネットワーク タイプを BSTR として取得する。
CreateTuneRequest空の (初期化されていない) チューニング要求を表す COM オブジェクトを作成する。
EnumCategoryGUIDs(現時点では未実装) DirectShow カテゴリ GUID を列挙する列挙子を作成する。カテゴリ GUID は、チューニング空間をサポートするフィルタの種類を表すものである。
EnumDeviceMonikers(現時点では未実装) このチューニング空間をサポートするチューナー入力 (フィルタ) を表すデバイス モニカの列挙子を作成する。
get_DefaultPreferredComponentTypes優先コンポーネント タイプのリストを返す。優先コンポーネント タイプは、優先オーディオ ストリームなどのパラメータを指定するものである。
put_DefaultPreferredComponentTypes優先コンポーネント タイプのリストを作成する。優先コンポーネント タイプは、優先オーディオ ストリームなどのパラメータを指定するものである。
get_FrequencyMappingネットワーク プロバイダが put_FrequencyMapping を呼び出して直前に作成した周波数マッピングを取得する。
put_FrequencyMapping周波数とチャンネルのマッピング、周波数と中継器のマッピング、またはキャリア周波数から周波数識別子への、チューニング空間に適したその他のあらゆるマッピングを作成する。
get_DefaultLocatorローカル システムのデフォルト ロケータを取得する。
put_DefaultLocatorローカル システムのデフォルト ロケータを設定する。
Cloneチューニング空間の新しいコピーを作成する。

ITuningSpace::get_UniqueName

ITuningSpace インターフェイス

チューニング空間の固有の名称を取得する。固有の名称は略称か GUID である。

構文

HRESULT get_UniqueName(
BSTR* Name
    );

パラメータ

Name
[out, retval] 固有の名称を受け取る BSTR 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

固有の名称は、グローバルに一意な任意の文字列である。

ITuningSpace::put_UniqueName

ITuningSpace インターフェイス

チューニング空間の固有の名称を設定する。固有の名称は略称か GUID である。

構文

HRESULT put_UniqueName(
BSTR Name
    );

パラメータ

Name
[in] 固有の名称を指定する BSTR 型変数。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpace::get_FriendlyName

ITuningSpace インターフェイス

チューニング空間のローカライズされたフレンドリ名を取得する。

構文

HRESULT get_FriendlyName(
BSTR* Name
    );

パラメータ

Name
[out, retval] フレンドリ名を受け取る BSTR 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpace::put_FriendlyName

ITuningSpace インターフェイス

チューニング空間のローカライズされたフレンドリ名を設定する。

構文

HRESULT put_FriendlyName(
    BSTR Name
    );

パラメータ

Name
[in] フレンドリ名を指定する BSTR 型変数。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpace::get_CLSID

ITuningSpace インターフェイス

チューニング空間の CLSID を BSTR として取得する。

構文

HRESULT get_CLSID(
    BSTR* SpaceCLSID
    );

パラメータ

SpaceCLSID
[out, retval] チューニング空間の CLSID を受け取る BSTR 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

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

ITuningSpace::get_NetworkType

ITuningSpace Interface

チューニング空間のネットワーク タイプを BSTR として取得する。

構文

HRESULT get_NetworkType(
    BSTR* NetworkTypeGuid
    );

パラメータ

NetworkTypeGuid
[out, retval] ネットワーク タイプを示す GUID を受け取る BSTR 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

フィルタ グラフ構築時には、このメソッドで取得した GUID を、ネットワーク プロバイダ フィルタを作成するための CLSID として使用する。このメソッドは、Visual Basic® とスクリプト アプリケーション用に提供される。C++ アプリケーションでは、get__NetworkType を使って、ネイティブな GUID データ型としてネットワーク タイプを取得すること。

ITuningSpace::put_NetworkType

ITuningSpace Interface

チューニング空間のネットワーク タイプを BSTR として指定する。

構文

HRESULT put_NetworkType(
    REFCLSID NetworkTypeGuid
    );

パラメータ

NetworkTypeGuid
[in] ネットワーク タイプを指定する BSTR 型変数。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このメソッドは、Visual Basic® とスクリプト アプリケーション用に提供される。C++ アプリケーションでは、put__NetworkType を使うこと。

ITuningSpace::get__NetworkType

ITuningSpace Interface

チューニング空間のネットワーク タイプを GUID として取得する。

構文

HRESULT get_NetworkType(
    GUID* NetworkTypeGuid
    );

パラメータ

NetworkTypeGuid
[out, retval] ネットワーク タイプを受け取る GUID 型変数へのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

フィルタ グラフの構築時にネットワーク プロバイダを作成するときは、このメソッドで取得される GUID を CLSID として使用する。

ITuningSpace::put__NetworkType

ITuningSpace Interface

チューニング空間のネットワーク タイプを REFCLSID として指定する。

構文

HRESULT put__NetworkType(
    BSTR NetworkTypeGuid
    );

パラメータ

NetworkTypeGuid
[in] ネットワーク タイプを指定する REFCLSID 型変数。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpace::CreateTuneRequest

ITuningSpace インターフェイス

空の (初期化されていない) チューニング要求を表す COM オブジェクトを作成する。

構文

HRESULT CreateTuneRequest(
    ITuneRequest** TuneRequest
    );

パラメータ

TuneRequest
[out, retval] 新しいチューニング要求オブジェクトを受け取る ITuneRequest インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このメソッドは ITuneRequest 基底クラス インターフェイスを返すが、このインターフェイスを使ってチューニング要求を作成することはできない。チューニング要求を作成するには、使用しているチューニング空間のタイプに関連付けられた派生インターフェイスを使う必要がある。派生インターフェイスを取得するには、返された ITuneRequest オブジェクトの QueryInterface を呼び出し、必要なインターフェイスを指定する。次の一覧は、チューニング空間とチューニング要求の関係を示す。

チューニング空間チューニング要求
IAnalogTVTuningSpaceIID_IChannelTuneRequest
IAnalogRadioTuningSpaceIID_IChannelTuneRequest
IDVBTuningSpaceIID_IDVBTuneRequest
IATSCTuningSpaceIID_IATSCChannelTuneRequest

ITuningSpace::EnumCategoryGUIDs

ITuningSpace インターフェイス

(現時点では未実装) DirectShow カテゴリ GUID を列挙する列挙子を作成する。カテゴリ GUID は、チューニング空間をサポートするフィルタの種類を表すものである。

構文

HRESULT EnumCategoryGUIDs(
    IEnumGUID** ppEnum
    );

パラメータ

ppEnum
[out, retval] 返された列挙オブジェクトを受け取る IEnumGUID インターフェイス ポインタのアドレス。

戻り値

E_NOTIMPL を返す。

注意

このメソッドにオートメーション言語からアクセスすることはできない。

ITuningSpace::EnumDeviceMonikers

ITuningSpace インターフェイス

(現時点では未実装) このチューニング空間をサポートするチューナー入力 (フィルタ) を表すデバイス モニカの列挙子を作成する。

構文

HRESULT EnumDeviceMonikers(
    IEnumMoniker** ppEnum
    );

パラメータ

ppEnum
[out, retval] 返された列挙オブジェクトを受け取る IEnumMoniker インターフェイス ポインタのアドレス。

戻り値

E_NOTIMPL を返す。

注意

このメソッドにオートメーション言語からアクセスすることはできない。

ITuningSpace::get_DefaultPreferredComponentTypes

ITuningSpace インターフェイス

優先コンポーネント タイプのリストを返す。優先コンポーネント タイプは、優先オーディオ ストリームなどのパラメータを指定するものである。

構文

HRESULT get_DefaultPreferredComponentTypes(
    IComponentTypes** ComponentTypes
    );

パラメータ

ComponentTypes
[out, retval] 返されたコレクションを受け取る IComponentTypes インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このコンテキストでは、プログラム内のストリームを "コンポーネント" と言う。"優先コンポーネント" には、たとえば英語のオーディオ ストリームなどが設定されている。コンポーネントまたはサブストリームが複数ある場合、チューナーは必ず優先コンポーネントを先に再生しようとする。

ITuningSpace::put_DefaultPreferredComponentTypes

ITuningSpace インターフェイス

優先コンポーネント タイプのリストを作成する。優先コンポーネント タイプは、優先オーディオ ストリームなどのパラメータを指定するものである。

構文

HRESULT put_DefaultPreferredComponentTypes(
    IComponentTypes* NewComponentTypes
    );

パラメータ

NewComponentTypes
[in] デフォルトの優先コンポーネント タイプを指定する ComponentTypes オブジェクトの IComponentTypes インターフェイスへのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

ITuningSpace::get_FrequencyMapping

ITuningSpace インターフェイス

ネットワーク プロバイダが put_FrequencyMapping を呼び出して直前に作成した周波数マッピングを取得する。

構文

HRESULT get_FrequencyMapping(
    BSTR* pMapping
    );

パラメータ

pMapping
[out, retval] ネットワーク プロバイダが作成した周波数マッピングを受け取る BSTR。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

この BSTR はバイナリ ラージ オブジェクト (BLOB) として処理される。この BSTR には、NULL が埋め込まれ、ネットワーク プロバイダがふさわしいと判断する書式で内部的にフォーマットされる可能性がある。

ITuningSpace::put_FrequencyMapping

ITuningSpace インターフェイス

周波数とチャンネルのマッピング、周波数と中継器のマッピング、またはキャリア周波数から周波数識別子への、チューニング空間に適したその他のあらゆるマッピングを作成する。

構文

HRESULT put_FrequencyMapping(
    BSTR Mapping
    );

パラメータ

Mapping
[in] 周波数マッピングが格納された BSTR。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

このメソッドは、周波数マッピングが入った文字列を格納するために、ネットワーク プロバイダから使用される。

ITuningSpace::get_DefaultLocator

ITuningSpace インターフェイス

ローカル システムのデフォルト ロケータを取得する。

構文

HRESULT get_DefaultLocator(
    ILocator** LocatorVal
    );

パラメータ

LocatorVal
[out, retval] 返された ILocator インターフェイスを受け取るポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

デフォルトのロケータは、インストール後に IScanningTuner オブジェクトの始点として使用できる。

ITuningSpace::put_DefaultLocator

ITuningSpace インターフェイス

ローカル システムのデフォルト ロケータを設定する。

構文

HRESULT put_DefaultLocator(
    ILocator* LocatorVal
    );

パラメータ

LocatorVal
[in] デフォルトのロケータとして設定するオブジェクトの ILocator インターフェイスへのポインタ。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。

注意

デフォルトのロケータは、インストール後に IScanningTuner オブジェクトの始点として使用できる。

ITuningSpace::Clone

ITuningSpace インターフェイス

新しいチューニング空間をコピーする。

構文

HRESULT Clone(
    ITuningSpace** NewTS
    );

パラメータ

NewTS
[out, retval] 新しいチューニング空間オブジェクトがセットされる ITuningSpace インターフェイス ポインタのアドレス。

戻り値

成功した場合は、S_OK を返す。失敗した場合は、標準の IErrorInfo インターフェイスを使ってエラー情報を取得できる。