Microsoft DirectX 8.0

IComponent インターフェイス

IComponent インターフェイスは、すべての Component オブジェクトの基底クラス インターフェイスであり、コンポーネント (主にプログラム ストリーム内の基本ストリーム) の一般的な特性を記述する。IMPEG2Component などの派生インターフェイスは、IComponent を継承し、コンポーネントに関する所定のネットワーク タイプ固有のプロパティを記述する。受信が開始すると、トランスポート情報フィルタ (TIF) が、Component オブジェクトを作成してチューニング要求にアタッチする。すべての Component オブジェクトは、IPersistPropertyBag をサポートする。

メソッド名説明
get_Typeコンポーネントの一般的な特性を記述する IComponentType オブジェクトを取得する。
put_Typeコンポーネントの一般的な特性を記述する IComponentType オブジェクトを設定する。
get_DescLangID説明のプレゼンテーションに使用する言語を取得する。
put_DescLangID説明のプレゼンテーションに使用する言語を設定する。
get_Statusコンポーネントの要求された状態または実際の状態を取得する。
put_Statusコンポーネントの要求された状態または実際の状態を設定する。
get_Descriptionコンポーネントの説明を取得する。
put_Descriptionコンポーネントの説明を設定する。
Cloneコンポーネントの新しいコピーを作成する。

IComponent::Clone

IComponent インターフェイス

コンポーネントの新しいコピーを作成する。

構文

HRESULT Clone(
    IComponent** NewComponent
    );

パラメータ

NewComponent
[out, retval] 新しいコンポーネントに設定する IComponent インターフェイスへのポインタ。

戻り値

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

IComponent::get_Type

IComponent インターフェイス

コンポーネントの一般的な特性を記述する IComponentType オブジェクトを取得する。

構文

HRESULT get_Type(
    IComponentType** CT
    );

パラメータ

CT
[out, retval] 取得したコンポーネントに設定する IComponentType インターフェイス ポインタのアドレス。

戻り値

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

IComponent::put_Type

IComponent インターフェイス

コンポーネントの一般的な特性を記述する IComponentType オブジェクトを設定する。

構文

HRESULT put_Type(
    IComponentType* CT
    );

パラメータ

CT
[in] コンポーネントに対応する新しい値を指定する IComponentType オブジェクトへのポインタ。

戻り値

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

注意

IComponent 基底クラス インターフェイスを使用しているときには、タイプに NULL を設定できる。同じことを IMPEG2Component 派生クラス インターフェイスで実行しようとすると、このメソッドは E_POINTER を返す。IMPEG2Component オブジェクトでは、設定するタイプとして IComponentType 基底クラス インターフェイスを持つことができない。この場合、メソッドは Type Mismatch (0x80020005) を返す。

IComponent::get_DescLangID

IComponent インターフェイス

説明のプレゼンテーションに使用する言語を取得する。

構文

HRESULT get_DescLangID(
short* LangID
    );

パラメータ

*LangID
[out, retval] 言語 ID を受け取る Short 型変数へのポインタ。

戻り値

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

注意

この言語は、Component オブジェクトに含まれる説明情報の言語である。ストリーム コンテンツの言語を定義する言語コンポーネント タイプ内の言語 ID とは異なる。

IComponent::put_DescLangID

IComponent インターフェイス

説明のプレゼンテーションに使用する言語を設定する。

構文

HRESULT put_DescLangID(
short LangID
    );

パラメータ

LangID
[in] 言語 ID を指定する Short 型変数。

戻り値

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

注意

この言語は、Component オブジェクトに含まれる説明情報の言語である。ストリーム コンテンツの言語を定義する言語コンポーネント タイプ内の言語 ID とは異なる。アプリケーションからこの値を修正すると、別の言語のサブストリームをアクティブにすることができる。

IComponent::get_Status

IComponent インターフェイス

コンポーネントの要求された状態または実際の状態を取得する。

構文

HRESULT get_Status(
    ComponentStatus* Status
    );

パラメータ

*Status
[out, retval] 状態の値を受け取る ComponentStatus 列挙型へのポインタ。

戻り値

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

注意

typedef enum ComponentStatus
	{
		[helpstring("Component is selected")] StatusActive,
		[helpstring("Component is not selected")] StatusInactive,
		[helpstring("Component is unavailable")] StatusUnavailable,
	} ComponentStatus;
  

チューナーは、Components コレクションにコンポーネントを追加するとき、コンポーネントがアクティブかどうかを指定できる。アプリケーションでは、この状態の設定を試みたうえで、チューニング要求を再発行できる。チューナーは状態を更新する。状態には Active、Inactive、Unavailable の 3 種類があるが、Unavailable は、アクティブにすることを要求されたとき、コンポーネントが実際に利用可能でない場合に、チューナーだけが設定する状態である。

IComponent::put_Status

IComponent インターフェイス

コンポーネントの要求された状態または実際の状態を設定する。

構文

HRESULT put_Status(
    ComponentStatus Status
    );

パラメータ

Status
[in] 状態の値を指定する ComponentStatus 型変数。

戻り値

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

注意

ストリーム コンポーネント (サブストリーム) をアクティブ/非アクティブにするには、このメソッドを使用する。

参照

get_Status

IComponent::get_Description

IComponent インターフェイス

コンポーネントの説明を取得する。

構文

HRESULT get_Description(
    BSTR* Description
    );

パラメータ

*Description
[out, retval] 説明を受け取る BSTR 型変数へのポインタ。

戻り値

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

注意

IComponent::put_Description

IComponent インターフェイス

コンポーネントの説明を設定する。

構文

HRESULT put_Description(
    BSTR Description
    );

パラメータ

Description
[in] 新しい説明が格納された BSTR 型変数。

戻り値

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

注意

このメソッドは、アプリケーションではなく、ガイド ストアから呼び出される。