BParameterWeb

Derived from: BFlattenable

Declared in: be/media/ParameterWeb.h

Library: libmedia.so

Allocation: Constructor only

Summary

　BParameterWebは、BControllable nodeの設定可能なパラメータの間の関係を記述する情報のコンテナとして使用されます。BControllableサブクラスは、コンストラクトされる際に、BParameterWebを生成し、それを一つないしは複数のBParameterGroupに、controlと一緒に住まわせます。このパラメータのwebは、node内の信号伝達を記述し、nodeのデータ処理の位置（point）を制御することができます。

　オーディオの制御パネル（Audio control panel）は実際、デフォルトの音声入力nodeとして現在選択されているnodeのBParameterWebから派生します。

　BParameterWebによって、クライアントのアプリケーションはそれがどのように設定されるかを決定するためにnodeを検索することができます。それによって、アプリケーションは標準のユーザインターフェイスオブジェクト（スライダー、チェックボックスや、データの経路を示す線と矢印など）を使用してユーザがnodeを設定を行うことを許可するユーザインターフェイスを生成し、表示することができます。

　parameter webを使用することで、デバイスを設定する一般的なコードを生成する能力を犠牲にせずに、デバイスに依存しない環境を維持することができます。

Constructor and Destructor

BParameterWeb()

	BParameterWeb()

　BParameterWebのコンストラクタ。一般的には、一つのBControllable nodeにつき一つのBParameterWebオブジェクトを生成するでしょう。BControllable nodeにBParameterWebを取り付けるには、BControllable::SetParameterWeb()を呼び出して下さい。

~BParameterWeb()

	~BParameterWeb()

　一度BControllable::SetParameterWeb()が呼び出されたら、そのnode（訳注 : BControllableのこと）はparameter webオブジェクトに関して責任を持つので、あなたはそれを削除してはいけません。

　もしBControllable::SetParameterWeb()を呼び出さなければ、それを使い終わった後に、そのBParameterWebを削除して下さい。

Member Functions

CountGroups()

	int32 CountGroups(void)

　現在BParameterWebに取り付けられているBParameterGroupの数を返します。

CountParameters()

	int32 CountParameters(void)

　webに取り付けられている全てのBParameterGroupを含め、web全体に於けるBParameterの数を返します。

GroupAt()

	BParameterGroup *GroupAt(int32 index)

　BParamterWebに含まれるグループのリストに於て、特定のindexに存在するBParameterGroupを返します。

　最初のグループは0と番号付けされているため、indexの合法的に最も大きな値はCountGroups() - 1 となります。もし指定されたindexが範囲外であれば、NULLが返されます。

MakeGroup()

	BParameterGroup *MakeGroup(const char *name)

　BParameterWeb内でパラメータをグループ化するために使用されるBParameterGroupを生成し、それをBParameterWebに取り付けます。

　あるグループ内に生成されたBParamterは、全てそのグループに所属し、再帰的にwebそのものに所属します。

もしそう望むなら、BParameterGroupを入れ子にすることができます。しかしながら、BParameterWebは複数のグループ間では共有できません。 Node()                                                              media_node Node(void) 　このBParameterWebオブジェクトを所有するBControllable nodeに対応するmedia_nodeを返します。 　もしBParameterWebがまだBControllableに取り付けられていなければ、media_node::nullが返されます。 ParameterAt()                                                              BParameter *ParameterAt(int32 index) 　取り付けられた全てのグループを含むBParameterWeb全体の中で、指定されたindexにあるBParameterを返します。 The Media Kit Table of Contents     The Media Kit Index The Be Book, ...in lovely HTML... for BeOS Release 5. Copyright © 2000 Be, Inc. All rights reserved..