Microsoft DirectX 8.0

ITuner インターフェイス

ITuner は、ネットワーク プロバイダ フィルタに実装される。

メソッド名説明
get_TuningSpaceネットワーク プロバイダ用の現在有効なチューニング空間を取得する。
put_TuningSpaceネットワーク プロバイダ用のチューニング空間を設定する。
EnumTuningSpacesこの実装で優先されるチューニング空間のコレクションを作成する。
get_TuneRequestネットワーク プロバイダ用の現在有効なチューニング要求を取得する。
put_TuneRequestネットワーク プロバイダ用のチューニング要求を設定する。
Validateチューニング要求を実行できるかどうかを示す値を返す。
get_PreferredComponentTypesデフォルト コンポーネントの選択に使用する ComponentType オブジェクトのコレクションを取得する。
put_PreferredComponentTypesデフォルト コンポーネントの選択に使用する ComponentType オブジェクトのコレクションを設定する。
get_SignalStrengthネットワーク プロバイダ固有の信号強度メトリックを取得する。
TriggerSignalEventsISignalEvents::OnSignal が繰り返し呼び出されるモードにネットワーク プロバイダを切り替える。

ITuner::get_TuningSpace

ITuner インターフェイス

ネットワーク プロバイダ用の現在有効なチューニング空間を取得する。

構文

HRESULT get_TuningSpace(
ITuningSpace** TuningSpace
    );

パラメータ

TuningSpace
[out, retval] 現在のチューニング空間に設定する ITuningSpace インターフェイス ポインタのアドレス。

戻り値

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

ITuner::put_TuningSpace

ITuner インターフェイス

ネットワーク プロバイダ用のチューニング空間を設定する。

構文

HRESULT put_TuningSpace(
ITuningSpace* TuningSpace
    );

パラメータ

TuningSpace
[in] ネットワーク プロバイダに設定するチューニング空間へのポインタ。

戻り値

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

ITuner::EnumTuningSpaces

ITuner インターフェイス

この実装で優先されるチューニング空間のコレクションを作成する。

構文

HRESULT EnumTuningSpaces(
IEnumTuningSpaces** ppEnum
    );

パラメータ

ppEnum
[out, retval] 返されるコレクションに設定する IEnumTuningSpaces インターフェイス ポインタのアドレス。

戻り値

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

注意

このリストは、この実装と互換性のあるチューニング空間のサブセットである。

ITuner::get_TuneRequest

ITuner インターフェイス

ネットワーク プロバイダ用の現在有効なチューニング要求を取得する。

構文

HRESULT get_TuneRequest(
ITuneRequest** TuneRequest
    );

パラメータ

TuneRequest
[out, retval] 返されるオブジェクトに設定する ITuneRequest インターフェイス ポインタのアドレス。

戻り値

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

注意

チューナーにチューニング要求を発行した後に、その Components コレクションの内容が設定される。アプリケーションでは、プログラムへのチューニング後に get_TuneRequest を呼び出して、そのプログラムで現在利用可能なコンポーネントを判断し、さらに、コレクションに含まれるコンポーネントオブジェクトの IComponent::put_Status メソッドを使って、そのコンポーネントをアクティブまたは非アクティブにすることができる。アプリケーションでオーディオ ストリームを (たとえば英語からスペイン語に) 切り替える場合には、この方法で行う。

ITuner::put_TuneRequest

ITuner インターフェイス

ネットワーク プロバイダ用の現在有効なチューニング要求を設定する。

構文

HRESULT put_TuneRequest(
ITuneRequest* TuneRequest
    );

パラメータ

TuneRequest
[in] ネットワーク プロバイダの設定に使用する ITuneRequest オブジェクトへのポインタ。

戻り値

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

注意

このメソッドを呼び出すと、チューニング要求のプロパティに基づいてチューニング処理が開始する。チューニング処理は非同期で行われる可能性がある。

ITuner::Validate

ITuner インターフェイス

チューニング要求を実行できるかどうかを示す値を返す。

構文

HRESULT Validate(
ITuneRequest* TuneRequest
    );

パラメータ

TuneRequest
[in] チューニング要求オブジェクトへのポインタ。

戻り値

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

注意

入力として IUnknown* を受け付ける。ネットワーク プロバイダは、まず、優先されるチューニング要求インターフェイスを照会する。見つかった場合は、チューニング要求を実行できるかどうかを確認する。見つからなければ、優先されるチューニング空間インターフェイスを照会する。見つかった場合は、所定のチューニング空間にあわせてネットワーク プロバイダ自体を構成できるかどうかを確認する。

ITuner::get_PreferredComponentTypes

ITuner インターフェイス

デフォルト コンポーネントの選択に使用する ComponentType オブジェクトのコレクションを取得する。

構文

HRESULT get_PreferredComponentTypes(
IComponentTypes** ComponentTypes
    );

パラメータ

ComponentTypes
[out, retval] ComponentType オブジェクトのコレクションを受け取る IComponentTypes インターフェイス ポインタのアドレス。

戻り値

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

注意

プログラムが終了すると、新しいサブストリーム ("コンポーネント") のセットが利用可能になる可能性がある。このため、チューナーは、優先コンポーネント タイプのリストを自動的に調べ、そのリストに従ってサブストリームを選択する。リストがない場合は、ほかの要因に基づいて選択が行われる。アプリケーションでは、単に現在のリストを調べるため、このメソッドを呼び出す。

ITuner::put_PreferredComponentTypes

ITuner インターフェイス

デフォルト コンポーネントの選択に使用する ComponentType オブジェクトのコレクションを設定する。

構文

HRESULT put_PreferredComponentTypes(
IComponentTypes* ComponentTypes
    );

パラメータ

ComponentTypes
[in] ComponentType オブジェクトのコレクションが格納された IComponentTypes インターフェイスへのポインタ。

戻り値

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

注意

アプリケーションで優先コンポーネント タイプのリストを作成するには、空の ComponentTypes コレクションをインスタンス化し、そこに内容を設定してから put_PreferredComponentTypes を使ってチューナーに渡す。

ITuner::get_SignalStrength

ITuner インターフェイス

ネットワーク プロバイダ固有の信号強度メトリックを取得する。

構文

HRESULT get_SignalStrength(
long* Strength
    );

パラメータ

Strength
[out, retval] 信号強度を受け取る Long 型変数へのポインタ。

戻り値

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

注意

-1 は信号強度を判断できないことを表し、0 はチューニングされていないことを表す。また、大きい値は強い信号を意味する。デジタル チューナーの場合、FEC のビット エラー レート (BER) も同様に解釈できる。

ITuner::TriggerSignalEvents

ITuner インターフェイス

ISignalEvents::OnSignal が繰り返し呼び出されるモードにネットワーク プロバイダを切り替える。

構文

HRESULT TriggerSignalEvents(
long Interval
    );

パラメータ

Interval
[in] トリガー イベントの送信間隔を指定する Long 型変数。

戻り値

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

注意

このモードがサポートされていない場合は、E_NOTIMPL を返す。間隔には、Signal イベントの生成頻度をミリ秒単位で指定する。