BParameterGroup

Library: libmedia.so

Allocation: Constructor only

Summary

　BParameterGroupオブジェクトは、BParameterの論理的なグループ化を行うために使用されます。各々のBParameterは厳密にひとつのBParameterGroupに所属し、事実上、所属するBParameterGroupオブジェクトから生成されます。生成には、BParameterWeb::MakeGroup() 関数が使用されます。

　BParameterGroupは、もう一つのBParameterGroupの内部に入れ子にすることができます。

　BParameterWebに所有されるBParameterGroupオブジェクトは、BTabViewの様な複数のペインをもつ制御パネルのペインを表現するための、論理的な候補です。BTabViewは、それぞれのタブがもう一つのBparameterGroupのBParameterが表示される原因となります。

Constructor and Destructor

BParameterGroup()

BParameterGroup()

　new演算子によってBParameterGroupを直接生成するよりも、最上階層のグループを生成するためにはBParameterWeb::MakeGroup()を、サブグループを生成したいならBParameterGroup::MakeGroup()を、それぞれ呼び出して下さい。

~BParameterGroup()

~BParameterGroup()

　BParameterGroupオブジェクトを削除する必要はありません。webが削除されるとき、BParameterGroupを所有するBParameterWebが、それを行ってくれます。

Member Functions

CountGroups()

int32 CountGroups(void)

　グループ内のサブグループ数を返します。この数は、サブグループ内に入れ子にされているサブグループを含みません。

CountParameters()

int32 CountParameters(void)

　グループ内のBParameterの数を返します。この数は、サブグループ内のBParameterを含みません。

GroupAt()

BParameterGroup *ParameterGroup(int32 index)

　BParameterGroup内の指定されたindexにあるサブグループを返します。もしindexが負の数であるか、あるいはCountGroups() - 1 より大きければ、NULLが返されます。

MakeNullParameter()

BNullParameter *MakeNullParameter(int32 id, media_type type,
      const char *name, const char *kind)

　グループ内に、グループを所有するBParameterWebの内部に於てユニークな内部IDであるidによって、新しいBNullParameterを生成します。

　null parameterを通り抜けるメディアデータのタイプは、typeによって示されます。typeは、B_MEDIA_UNKNOWN_TYPEまたはB_MEDIA_NO_TYPEです。パラメータのnameは、nodeに関する情報を表示するクライアントアプリケーションによって表示され、パラメータは指定されたkindとなります。

Constant Description
B_WEB_PHYSICAL_INPUT このパラメータは、（マイクのジャックやライン入力ジャックといった）物理入力を表現する。
B_WEB_PHYSICAL_OUTPUT このパラメータは、（ライン出力のジャックやヘッドホンジャックといった）物理出力を表現する。
B_WEB_LOGICAL_INPUT このパラメータは、コンピュータとA/V入力機器の間でデータのビットが伝送されるポイントを表現する。
B_WEB_LOGICAL_OUTPUT このパラメータは、コンピュータとA/V出力機器の間でデータのビットが伝送されるポイントを表現する。
B_WEB_ADC_CONVERTER このパラメータは、アナログからデジタルへのコンバータを表現する。
B_WEB_DAC_CONVERTER このパラメータは、デジタルからアナログへのコンバータを表現する。
B_WEB_BUFFER_INPUT このパラメータは、media_inputを表現する。
B_WEB_BUFFER_OUTPUT このパラメータは、media_outputを表現する。
B_GENERIC このパラメータのkindは、以上に挙げられたものではない。

Constant	Description
`B_WEB_PHYSICAL_INPUT`	このパラメータは、（マイクのジャックやライン入力ジャックといった）物理入力を表現する。
`B_WEB_PHYSICAL_OUTPUT`	このパラメータは、（ライン出力のジャックやヘッドホンジャックといった）物理出力を表現する。
`B_WEB_LOGICAL_INPUT`	このパラメータは、コンピュータとA/V入力機器の間でデータのビットが伝送されるポイントを表現する。
`B_WEB_LOGICAL_OUTPUT`	このパラメータは、コンピュータとA/V出力機器の間でデータのビットが伝送されるポイントを表現する。
`B_WEB_ADC_CONVERTER`	このパラメータは、アナログからデジタルへのコンバータを表現する。
`B_WEB_DAC_CONVERTER`	このパラメータは、デジタルからアナログへのコンバータを表現する。
`B_WEB_BUFFER_INPUT`	このパラメータは、media_inputを表現する。
`B_WEB_BUFFER_OUTPUT`	このパラメータは、media_outputを表現する。
`B_GENERIC`	このパラメータのkindは、以上に挙げられたものではない。

　これらのkindは、制御パネルがシグナルフローのダイアグラムを描画する必要がある時に使用され、フロー中でこれらのポイントに対して適切なシンボルを使用することができます。

もしあなた自身のkindを生成したいなら、何も壊さずに（訳注 : 破壊的なコーディングをせずに）、それを案内するためにBe Developer Supportに連絡をとって下さい。

the BNullParameterクラスもご覧下さい。

MakeDiscreteParameter()

BDiscreteParameter *MakeDiscreteParameter(int32 id, media_type type,
      const char *name, const char *kind)

　新しくBDiscreteParameterオブジェクトを生成し、それをそのグループに取り付けます。BDiscreteParameterは、指定された内部的なidを持ちます。idは、そのグループを所有するBParameterWebの中においてユニークとなります。

　BDiscreteParameterは、指定されたtypeのメディアデータに影響し、また指定されたnameを持ちます。

　discrete parameter（不連続なパラメータ）のkindは、kindによって指定され、下記のうち任意の値を取ります :

Constant Description
B_MUTE このパラメータは、ミュート（消音）のcontrolを表現する。値が0であればデータは変更なしに渡され、一方値が1であればデータはミュートされる。
B_ENABLE このパラメータは、使用可能・不可能のトグルを表現する。値が0であればその機能を使用不能とし、一方値が1であれば使用可能にする。
B_INPUT_MUX このパラメータは、入力のMUXを表現する。値は、入力が受け渡されるMUXを指定する。
B_OUTPUT_MUX このパラメータは、出力のMUXを表現する。値は、入ってきたデータを出力が受け取るMUXを指定する。
B_TUNER_CHANNEL このパラメータは、（テレビのチャンネルのような）チャンネルチューナーを表現する。値はチャンネルの番号を示す。
B_TRACK このパラメータの値は、トラック番号を示す。
B_RECSTATE このパラメータは、nodeが停止中(0)、演奏中(1)または録音中(2)であることを示す。
B_SHUTTLE_MODE このパラメータは、演奏モードを示します。-1は逆行演奏を、0は停止を、1は演奏を、2は一旦停止（pause）を表す。
B_RESOLUTION このパラメータは、ビデオまたは音声の解像度（resolution）を示す。
B_COLOR_SPACE このパラメータは、ビデオの色空間（color space）を示す。
B_FRAME_RATE このパラメータは、フレームレートを拾い出すセレクタを表現する。

Constant	Description
`B_MUTE`	このパラメータは、ミュート（消音）のcontrolを表現する。値が0であればデータは変更なしに渡され、一方値が1であればデータはミュートされる。
`B_ENABLE`	このパラメータは、使用可能・不可能のトグルを表現する。値が0であればその機能を使用不能とし、一方値が1であれば使用可能にする。
`B_INPUT_MUX`	このパラメータは、入力のMUXを表現する。値は、入力が受け渡されるMUXを指定する。
`B_OUTPUT_MUX`	このパラメータは、出力のMUXを表現する。値は、入ってきたデータを出力が受け取るMUXを指定する。
`B_TUNER_CHANNEL`	このパラメータは、（テレビのチャンネルのような）チャンネルチューナーを表現する。値はチャンネルの番号を示す。
`B_TRACK`	このパラメータの値は、トラック番号を示す。
`B_RECSTATE`	このパラメータは、nodeが停止中(0)、演奏中(1)または録音中(2)であることを示す。
`B_SHUTTLE_MODE`	このパラメータは、演奏モードを示します。-1は逆行演奏を、0は停止を、1は演奏を、2は一旦停止（pause）を表す。
`B_RESOLUTION`	このパラメータは、ビデオまたは音声の解像度（resolution）を示す。
`B_COLOR_SPACE`	このパラメータは、ビデオの色空間（color space）を示す。
`B_FRAME_RATE`	このパラメータは、フレームレートを拾い出すセレクタを表現する。

MakeContinuousParameter()

BContinuousParameter *MakeContinuousParameter(int32 id, media_type type,
      const char *name, const char *kind, const char *unit,
      float minValue, float maxValue, float step)

　新しくBContinuousParameterオブジェクトを生成し、それをグループに取り付けます。BContinuousParameterは、指定された内部的なidを持ちます。idは、そのグループを所有するBParameterWebの中でユニークとなります。

　BContinuousParameterは、指定されたtypeのメディアデータに影響し、指定されたnameを持ちます。

　BContinuousParameterが表現するparameterのkindは、kindによって指定され、下記のうち任意の値をとります。

Constant Description
B_MASTER_GAIN このパラメータは、メイン音量のcontrolを表現する。
B_GAIN このパラメータは、ゲインのcontrolを表現する。
B_BALANCE このパラメータは、バランスのcontrolを表現する。
B_FREQUENCY このパラメータは、ラジオのチューナーの様に周波数（frequency）を表現する。
B_LEVEL このパラメータは、EQ（イコライザ）やエフェクタの様にレベルを表現する。
B_SHUTTLE_SPEED このパラメータは、再生速度を表現する。1.0の値は、ノーマルな速度を示す。1.0より小さければより遅く、1.0より大きければより速く再生する。
B_CROSSFADE このパラメータは、ミキシングされる音声及びビデオに対してクロスフェードを示す。0はストリームの最初のペアが存在すべきであることを示し、100は、それ以外が存在すべきであることを示す。中間の値は、行われるミキシングの程度を示す。
B_COMPRESSION このパラメータは、圧縮比を示す。0の値は非圧縮を、99は100:1の圧縮を示す。
B_QUALITY このパラメータは、品質のレベルを示す。値が0であれば最大の圧縮を、100は非圧縮を示します。
B_BITRATE このパラメータは、1秒あたりのビット数、ビットレートを示す。
B_GOP_SIZE このパラメータは、キーフレームから分離されたフレームがいくつビデオストリームに挿入されるかといった「画像のグループ（group of pictures）」を示す。
B_TUNER_CHANNEL このパラメータは、（テレビのチャンネルのような）チャンネルチューナーを表現する。値はチャンネルの番号を示す。

Constant	Description
`B_MASTER_GAIN`	このパラメータは、メイン音量のcontrolを表現する。
`B_GAIN`	このパラメータは、ゲインのcontrolを表現する。
`B_BALANCE`	このパラメータは、バランスのcontrolを表現する。
`B_FREQUENCY`	このパラメータは、ラジオのチューナーの様に周波数（frequency）を表現する。
`B_LEVEL`	このパラメータは、EQ（イコライザ）やエフェクタの様にレベルを表現する。
`B_SHUTTLE_SPEED`	このパラメータは、再生速度を表現する。1.0の値は、ノーマルな速度を示す。1.0より小さければより遅く、1.0より大きければより速く再生する。
`B_CROSSFADE`	このパラメータは、ミキシングされる音声及びビデオに対してクロスフェードを示す。0はストリームの最初のペアが存在すべきであることを示し、100は、それ以外が存在すべきであることを示す。中間の値は、行われるミキシングの程度を示す。
`B_COMPRESSION`	このパラメータは、圧縮比を示す。0の値は非圧縮を、99は100:1の圧縮を示す。
`B_QUALITY`	このパラメータは、品質のレベルを示す。値が0であれば最大の圧縮を、100は非圧縮を示します。
`B_BITRATE`	このパラメータは、1秒あたりのビット数、ビットレートを示す。
`B_GOP_SIZE`	このパラメータは、キーフレームから分離されたフレームがいくつビデオストリームに挿入されるかといった「画像のグループ（group of pictures）」を示す。
`B_TUNER_CHANNEL`	このパラメータは、（テレビのチャンネルのような）チャンネルチューナーを表現する。値はチャンネルの番号を示す。

　測定の単位はunitによって指定され、parameterの値は、stepきざみでminValueからmaxValueまでの範囲をとることができます。

Name()

const char *Name(void)

　BParameterGroupの名前を返します。この名前は、ユーザに対して表示されます。例えば、BTabのラベルとして使用される可能性があります。

ParameterAt()

BParameter *ParameterAt(int32 index)

　BParameterGroup内の指定されたindexにある、BParameterを返します。

Web()

BParameterWeb *Web(void)

　そのグループを所有するBParameterWebを返します。

The Media Kit Table of Contents

The Media Kit Index

The Be Book,
...in lovely HTML...
for BeOS Release 5.