|
「パラメータ（parameter）」という語は、Media Kitの用語としては、BControllable nodeによって処理されるデータの取り扱いが設定される場所（point）を参照しますが、実際のユーザインターフェイスオブジェクトを参照しません。BControllable nodeに対してユーザインターフェイスを生成する方法に関する情報については、BMediaThemeクラスをご覧下さい。
BParameterクラスは抽象クラスです。実際にパラメータを生成し、それをBParameterWebに追加するには、一般的にBParameterGroupクラスのMakeNullParameter()、MakeDiscreteParameter()及びMakeContinuousParameter()を使用します。
Hook Function
Constructor and DestructorBParameterオブジェクトは、BParameterGroupクラスの適切な関数を用いてのみ生成されます。
Member Functions
AddInput() , AddOutput()
AddInput()は、input によって指定されたBParameterを、データをBParameterに渡すためのBParameterのセットに追加します。指定されたinputパラメータのAddOutput()関数によって、このパラメータにデータを送っていることを知らせるために呼び出されます。AddOutput()は、outputによって指定されるBParameterを、BParameterがデータを出力するBParameterのセットに追加します。指定されたoutputパラメータのAddInput()関数は、 このパラメータからデータを受け取っていることを知らせるために呼び出されます。 RETURN CODES B_OK. アイテムは、問題なくリストに追加された。
CountChannels() , SetChannelCount()
いくつかのBParameterは、同じ型のチャンネルを一つ以上持っています。例えば、左右のゲインが独立しているステレオ音量のパラメータは、二つのチャンネルを持っています。一方、左右両方に同じレベルで影響する単独のパラメータ値は、ただ一つのチャンネルのみ持っています。CountChannels()は、BParameterによって操作されるチャンネルの数を返します。 デフォルトのチャンネル数は1です。もしあなたのnodeが更に多くのチャンネルを提供したいなら、BParameterを生成した後にSetChannelCount()を呼び出して下さい。SetChannelCount()は、パラメータが操作するチャンネルの数を指定します。
CountInputs() , CountOutputs()
これら二つの関数は、現在BParameterに接続されている入力または出力の数を返します。入力または出力の数は、チャンネル数とは異っているでしょう（例えば単独のステレオ音声入力または出力は、左のチャンネルと右のチャンネルから成り立っています）。
GetValue() , SetValue()
GetValue()は、BParameterの現在の値を返します。関数の呼び出し時、bufferは、現在BParameterの値が保存されている場所を示すメモリのioSizeバイトを指し示します。関数が返る際には、ioSizeはバッファに実際に返されるバイト数を示し、lastChangeはBParameterの値が最後に変更された時間を示します。 SetValue()は、BParameterの値を変更します。sizeバイトの長さの新しい値は、指定されたbufferから得られます。変更は、changeWhenによって指定されたperformance timeに有効になります。 もしパラメータが複数のチャンネルを持っているなら、bufferは、全てのチャンネルの値を内包するのに十分な大きさとなるべきであり、ioSizeまたはsizeは、バッファ全体のサイズを示すべきです。 これらの呼び出しは、単純にBControllable::GetControlValue()及びBControllable::SetControlValue()関数をディスパッチしています。 RETURN CODES B_OK. エラーなし。
Group()
直接BParameterを内包するBParameterGroupを返します。
ID()
BParameterのID番号を返します。このIDは、値を変更する要求を適切な場所に発送するため、nodeによって使用されます。この値はBParameterを内包するBParameterWebの内部でのみユニークとなります。
InputAt() , OutputAt()
InputAt()は、indexで指定された入力番号にデータを送り込むBParameterを返します。indexは、0からCountInputs() - 1 の範囲です。 OutputAt()は、indexで指定された出力番号からデータを受け取るBParameterを返します。indexは、0からCountOutputs() - 1 の範囲です。 両方の関数とも、もし不正なindexが指定されたら、NULLを返します。
Kind()
BParameterのkind（種類）を返します。kindは可読である必要はありません。また、kindはBParameterによって供給される設定オプションを視覚的に表現するために生成するBControlの種類を判別するために使用することができます。 使用できるkindに関するより詳細な情報は、BParameterGroup::MakeNullParameter()、BParameterGroup::MakeDiscreteParameter()及びBParameterGroup::MakeContinuousParameter()関数をご覧下さい。
MediaType() , SetMediaType()
MediaType()は、BParameterを通して流れるメディアデータのタイプを返します。 SetMediaType()は、メディアデータの記録形式を変更します。でフォルトでは、もし変更されていなければ、B_MEDIA_NO_TYPEとなります。 BParameterのmedia_typeは、データのフォーマットを利害関係のある仲間に対して通知するために使用されます。それは情報の設定することであり、どんな形であれBParameterを流れるデータに変更を加えることはありません。
Name()
ユーザに対して表示するのに適切なBParameterの名前を返します（例えば、それはユーザインターフェイスオブジェクトに於てラベルとして使用される可能性があります）。
Channels()
SetMediaType() see MediaType()
SetValue() see GetValue()
Type()
オブジェクトが表現するパラメータのkindを返します。
Unit()
BParameterに使用される計測の単位を返します。例えば、これは「dB」「kHz」または「fps」となるでしょう。これはユーザインターフェイスに表示されるため、人間に読むことができなければなりません。
ValueType()
BParameterの値のデータ型の型を示す type codeを返します。これは普通、セレクタのためにB_INT32_TYPEであるか、またはスライダのためにB_FLOAT_TYPEであるかです。
Web()
このBParameterを内包するBParameterWebを返します。
Constants
Parameter KindsDeclared in: <be/media/ParameterWeb.h>
BParameterオブジェクトによって表現されるパラメータのkindを示します。 B_VIDEO_FORMAT kindは、それに関連した特定の値を持ちます :
media_parameter_typeDeclared in: <be/media/ParameterWeb.h>
Type()関数によって返されうるパラメータのタイプです。これは、そのオブジェクトがどのBParameterのサブクラスであるかを示します。
|