Класс FloatControl

java.lang.Object

javax.sound.sampled.Control

javax.sound.sampled.FloatControl

public abstract class FloatControl extends Control

Объект типа FloatControl предоставляет управление диапазоном значений с плавающей запятой. Управление с плавающей запятой часто представлено в графическом пользовательском интерфейсе с помощью объектов, которые можно непрерывно настраивать, таких как ползунки или регуляторы. Конкретные подклассы FloatControl реализуют управления, такие как усиление и панорамирование, которые влияют на аудиосигнал линейки каким-либо образом, что приложение может изменить. Внутренний класс FloatControl.Type предоставляет статические экземпляры типов, используемые для идентификации некоторых распространённых типов управления с плавающей запятой.

Абстрактный класс FloatControl предоставляет методы для установки и получения текущего значения управления с плавающей запятой. Другие методы получают возможный диапазон значений и разрешение управления (наименьший прирост между возвращаемыми значениями). Некоторые управления с плавающей запятой позволяют плавно изменять значение до нового значения за заданный период времени. FloatControl также содержит методы, которые возвращают строковые метки для минимального, максимального и среднего положения управления.

Since:

1.3

See Also:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static class`	`FloatControl.Type`	Экземпляр внутреннего класса `FloatControl.Type` идентифицирует один тип управления с плавающей запятой.

Краткое описание конструкторов

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

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

Модификатор	Конструктор	Описание
`protected`	Создаёт новый объект управления с плавающей запятой с заданными параметрами.
`protected`	Создаёт новый объект управления с плавающей запятой с заданными параметрами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`float`	`getMaximum()`	Получает максимальное разрешённое значение.
`String`	`getMaxLabel()`	Получает метку для максимального значения, например, "Справа" или "Полностью".
`String`	`getMidLabel()`	Получает метку для значения середины, например, "Центр" или "По умолчанию".
`float`	`getMinimum()`	Получает минимальное разрешённое значение.
`String`	`getMinLabel()`	Получает метку для минимального значения, например, "Слева" или "Выключено".
`float`	`getPrecision()`	Получает разрешение или гранулярность управления в единицах, в которых управление измеряется.
`String`	`getUnits()`	Получает метку для единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду".
`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; initialValue - значение, с которого начинается управление при создании; units - метка для единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду"; minLabel - метка для минимального значения, например, "Слева" или "Выкл"; midLabel - метка для значения середины, например, "Центр" или "По умолчанию"; maxLabel - метка для максимального значения, например, "Справа" или "Полностью"
Исключение:: 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; initialValue - значение, с которого начинается управление при создании; units - метка для единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду"
Исключение:: 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()

Получает метку для единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду".

Возвращает:: метку единиц или строку нулевой длины, если метка отсутствует

getMinLabel

public String getMinLabel()

Получает метку для минимального значения, например, "Слева" или "Выкл".

Возвращает:: метку минимального значения или строку нулевой длины, если метка не была установлена

getMidLabel

public String getMidLabel()

Получает метку для значения середины, например, "Центр" или "По умолчанию".

Возвращает:: метку значения середины или строку нулевой длины, если метка не была установлена

getMaxLabel

public String getMaxLabel()

Получает метку для максимального значения, например, "Справа" или "Полностью".

Возвращает:: метку максимального значения или строку нулевой длины, если метка не была установлена

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
Возвращает:: строковое представление управления плавающей запятой

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/sound/sampled/FloatControl.html