javax.sound.sampled

クラス FloatControl

java.lang.Object

javax.sound.sampled.Control

javax.sound.sampled.FloatControl

public abstract class FloatControl
extends Control

FloatControl オブジェクトは、ある範囲の浮動小数点型の値のコントロールを提供します。浮動小数点型のコントロールは、スライダや回転ノブなど連続調整が可能なオブジェクトによって、グラフィカルユーザーインタフェースで表示されることがあります。ラインのオーディオに影響を与えるゲインやパンなどの FloatControl 実装コントロールの具象サブクラスは、アプリケーションが操作できる方法で信号を送ります。FloatControl.Type 内部クラスは、共通した種類の浮動小数点型のコントロールの特定に使用するタイプの静的インスタンスを提供します。

FloatControl 抽象クラスは、コントロールの現在の浮動小数点型の値を設定および取得するメソッドを提供します。ほかのメソッドは可能範囲値およびコントロールの精度 (戻り値間の最小増分) を取得します。浮動小数点型のコントロールには、指定された期間で新しい値に移行できるタイプのものもあります。FloatControl には、コントロールの最小、最大および中間の各位置の文字列ラベルを返すメソッドも含まれます。

導入されたバージョン:

1.3

関連項目:

Line.getControls(), Line.isControlSupported(javax.sound.sampled.Control.Type)

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
static class	FloatControl.Type FloatControl.Type 内部クラスのインスタンスは、浮動小数点型のコントロールの種類を識別します。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	FloatControl(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units) 指定されたパラメータで浮動小数点型のコントロールオブジェクトを新しく構築します。
protected	FloatControl(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units, String minLabel, String midLabel, String maxLabel) 指定されたパラメータで浮動小数点型のコントロールオブジェクトを新しく構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
float	getMaximum() 許可されている最大値を取得します。
String	getMaxLabel() 「Right」や「Full」など、最大値のラベルを取得します。
String	getMidLabel() 「Center」や「Default」など、中間点値のラベルを取得します。
float	getMinimum() 許可されている最小値を取得します。
String	getMinLabel() 「Left」や「Off」など、最小値のラベルを取得します。
float	getPrecision() コントロールの精度または粒度を、そのコントロールを測定する単位で取得します。
String	getUnits() 「dB」や「秒当たりのフレーム数」など、コントロールの値を表す単位のラベルを取得します。
int	getUpdatePeriod() シフト中にコントロールの値が変化可能な最小時間間隔を取得します。
float	getValue() このコントロールの現在の値を取得します。
void	setValue(float newValue) コントロールの現在の値を設定します。
void	shift(float from, float to, int microseconds) 初期値から最終値へ、指定された期間にわたってコントロールの値をマイクロ秒単位で直線的に変化させます。
String	toString() コントロールの文字列表現を提供します。

クラス javax.sound.sampled.Control から継承されたメソッド

getType

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

FloatControl

protected FloatControl(FloatControl.Type type,
            float minimum,
            float maximum,
            float precision,
            int updatePeriod,
            float initialValue,
            String units,
            String minLabel,
            String midLabel,
            String maxLabel)

指定されたパラメータで浮動小数点型のコントロールオブジェクトを新しく構築します。

パラメータ:

type - この浮動小数点型のコントロールオブジェクトが表すコントロールの種類

minimum - コントロールに許可されている最小値

maximum - コントロールに許可されている最大値

precision - コントロールの精度または粒度。これは有効な離散値間の増分の量です。

updatePeriod - shift 中にコントロールが 1 つの離散値から次の離散値に変わることができる、マイクロ秒単位の最小時間間隔

initialValue - コントロールを構築するときの開始の値

units - コントロールの値を表わす単位のラベルで、「dB」や「秒当たりのフレーム数」など

minLabel - 最小値のラベルで、「Left」や「Off」など

midLabel - 中間点値のラベルで、「Center」や「Default」など

maxLabel - 最大値のラベルで、「Right」や「Full」など

例外:

IllegalArgumentException - minimum が maximum より大きい場合、または initialValue が許容範囲に入らない場合

FloatControl

protected FloatControl(FloatControl.Type type,
            float minimum,
            float maximum,
            float precision,
            int updatePeriod,
            float initialValue,
            String units)

指定されたパラメータで浮動小数点型のコントロールオブジェクトを新しく構築します。最小、最大、および中間点の各値はゼロの長さの文字列に設定されます。

パラメータ:

type - この浮動小数点型のコントロールオブジェクトが表すコントロールの種類

minimum - コントロールに許可されている最小値

maximum - コントロールに許可されている最大値

precision - コントロールの精度または粒度。これは有効な離散値間の増分の量です。

updatePeriod - shift 中にコントロールが 1 つの離散値から次の離散値に変わることができる、マイクロ秒単位の最小時間間隔

initialValue - コントロールを構築するときの開始の値

units - コントロールの値を表わす単位のラベルで、「dB」や「秒当たりのフレーム数」など

例外:

IllegalArgumentException - minimum が maximum より大きい場合、または initialValue が許容範囲に入らない場合

メソッドの詳細

setValue

public void setValue(float newValue)

コントロールの現在の値を設定します。デフォルト実装では、指定された値を単に設定するだけです。指示された値が最大値より大きい場合、または最小値より小さい場合、IllegalArgumentException がスローされます。コントロールによっては、値が設定されたときに影響を受けるためにラインを開く必要があります。

パラメータ:

newValue - 必要な新規の値

例外:

IllegalArgumentException - 指示された値が許容範囲に入らない場合

getValue

public float getValue()

このコントロールの現在の値を取得します。

戻り値:

現行値

getMaximum

public float getMaximum()

許可されている最大値を取得します。

戻り値:

最大許容値

getMinimum

public float getMinimum()

許可されている最小値を取得します。

戻り値:

最小許容値

getUnits

public String getUnits()

「dB」や「秒当たりのフレーム数」など、コントロールの値を表す単位のラベルを取得します。

戻り値:

単位ラベル、またはラベルがない場合はゼロの長さの文字列

getMinLabel

public String getMinLabel()

「Left」や「Off」など、最小値のラベルを取得します。

戻り値:

最小値ラベル、またはラベル * が設定されていない場合はゼロの長さの文字列

getMidLabel

public String getMidLabel()

「Center」や「Default」など、中間点値のラベルを取得します。

戻り値:

中間点値ラベル、またはラベル * が設定されていない場合はゼロの長さの文字列

getMaxLabel

public String getMaxLabel()

「Right」や「Full」など、最大値のラベルを取得します。

戻り値:

最大値ラベル、またはラベル * が設定されていない場合はゼロの長さの文字列

getPrecision

public float getPrecision()

コントロールの精度または粒度を、そのコントロールを測定する単位で取得します。精度は、そのコントロールがサポートする浮動小数点型の値のセットにおける、離散的有効値間の増分の大きさです。

戻り値:

コントロールの精度

getUpdatePeriod

public int getUpdatePeriod()

シフト中にコントロールの値が変化可能な最小時間間隔を取得します。変更期間は、シフト中にコントロールが値を変更する回数の逆関数です。実装が時間によるシフト値をサポートしない場合、実装はコントロールの値をただちに最終値に設定し、このメソッドからは -1 が返されます。

戻り値:

マイクロ秒単位の変更期間、または時間によるシフトがサポートされない場合は -1

関連項目:

shift(float, float, int)

shift

public void shift(float from,
         float to,
         int microseconds)

初期値から最終値へ、指定された期間にわたってコントロールの値をマイクロ秒単位で直線的に変化させます。このメソッドはブロックされずに値を返します。シフトが完了するまで待ちません。実装は指定された時間内に操作を完了する必要があります。デフォルト実装は単に値を最終値へただちに変更します。

パラメータ:

from - シフト開始時の初期値

to - シフト後の最終値

microseconds - マイクロ秒単位でのシフトの最大期間

例外:

IllegalArgumentException - from または to の値が許容範囲に入らない場合

関連項目:

getUpdatePeriod()

toString

public String toString()

コントロールの文字列表現を提供します。

オーバーライド:

toString、クラス: Control

戻り値:

文字列説明