Класс AudioClip

java.lang.Object

fx.scene.media.AudioClip

public final class AudioClip
extends Object

Объект AudioClip представляет собой фрагмент аудио, который можно воспроизвести с минимальной задержкой. Клипы загружаются аналогично объектам Media, но имеют другое поведение, например, Media не может воспроизводить себя. Клипы также доступны для немедленного использования. Поведение воспроизведения — «выстрелил и забыл»: после вызова одного из методов воспроизведения единственным доступным управлением является stop(). Объект AudioClip также может быть воспроизведён несколько раз одновременно. Для достижения той же цели с использованием Media необходимо создавать новый объект MediaPlayer для каждого воспроизводимого звука параллельно. Объекты Media, однако, более подходят для долгоиграющих звуков. Это в первую очередь связано с тем, что AudioClip хранит в памяти исходные, не сжатые аудиоданные для всего звука, что может быть довольно большим для длинных аудиоклипов. Объект MediaPlayer будет содержать только достаточное количество декомпрессированных аудиоданных, предварительно загруженных в память, для воспроизведения в течение короткого периода времени, поэтому он гораздо эффективнее в плане использования памяти для длинных клипов, особенно если они сжаты.

Пример использования:


     AudioClip plonkSound = new AudioClip("http://somehost/path/plonk.aiff");
     plonkSound.play();

С:: JavaFX 2.0

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

Свойства
Тип	Свойство	Описание
`DoubleProperty`	`balance`	Относительные уровни громкости слева и справа для клипа.
`IntegerProperty`	`cycleCount`	Количество раз, которое будет воспроизведён клип при вызове `play()`.
`DoubleProperty`	`pan`	Относительное "центральное" положение клипа.
`IntegerProperty`	`priority`	Относительный приоритет клипа по отношению к другим клипам.
`DoubleProperty`	`rate`	Относительная скорость воспроизведения клипа.
`DoubleProperty`	`volume`	Относительный уровень громкости, с которым воспроизводится клип.

Краткое описание полей

Поля
Модификатор и тип	Поле	Описание
`static int`	`INDEFINITE`	При установке `cycleCount` в это значение, `AudioClip` будет циклически воспроизводиться до остановки.

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

Конструкторы
Конструктор	Описание
`AudioClip(String source)`	Создаёт `AudioClip`, загруженный из указанного URL-адреса источника.

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

Модификатор и тип	Метод	Описание
`DoubleProperty`	`balanceProperty()`	Относительные уровни громкости слева и справа для клипа.
`IntegerProperty`	`cycleCountProperty()`	Количество раз, которое будет воспроизведён клип при вызове `play()`.
`double`	`getBalance()`	Получить значение баланса по умолчанию для этого клипа.
`int`	`getCycleCount()`	Получить значение цикла по умолчанию.
`double`	`getPan()`	Получить значение панорамирования по умолчанию.
`int`	`getPriority()`	Получить значение приоритета воспроизведения по умолчанию.
`double`	`getRate()`	Получить значение скорости воспроизведения по умолчанию.
`String`	`getSource()`	Получить URL-адрес источника, используемый для создания этого `AudioClip`.
`double`	`getVolume()`	Получить значение уровня громкости по умолчанию.
`boolean`	`isPlaying()`	Указать, воспроизводится ли в данный момент этот `AudioClip`.
`DoubleProperty`	`panProperty()`	Относительное "центральное" положение клипа.
`void`	`play()`	Воспроизвести `AudioClip`, используя все параметры по умолчанию.
`void`	`play(double volume)`	Воспроизвести `AudioClip`, используя все параметры по умолчанию, кроме громкости.
`void`	`play(double volume, double balance, double rate, double pan, int priority)`	Воспроизвести `AudioClip`, используя заданные параметры.
`IntegerProperty`	`priorityProperty()`	Относительный приоритет клипа по отношению к другим клипам.
`DoubleProperty`	`rateProperty()`	Относительная скорость воспроизведения клипа.
`void`	`setBalance(double balance)`	Установить значение баланса по умолчанию.
`void`	`setCycleCount(int count)`	Установить значение цикла по умолчанию.
`void`	`setPan(double pan)`	Установить значение панорамирования по умолчанию.
`void`	`setPriority(int priority)`	Установить значение приоритета воспроизведения по умолчанию.
`void`	`setRate(double rate)`	Установить значение скорости воспроизведения по умолчанию.
`void`	`setVolume(double value)`	Установить значение уровня громкости по умолчанию.
`void`	`stop()`	Немедленно остановить всё воспроизведение этого `AudioClip`.
`DoubleProperty`	`volumeProperty()`	Относительный уровень громкости, с которым воспроизводится клип.

Методы, объявленные в классе java.lang.Object

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

Подробности свойства

Уровень громкости

public DoubleProperty volumeProperty

Относительный уровень громкости, с которым воспроизводится клип. Допустимый диапазон — от 0,0 (выключено) до 1,0 (полная громкость). Значения вне этого диапазона будут ограничены внутри, поэтому они не будут иметь дополнительного эффекта. Громкость регулируется затуханием, поэтому значения ниже 1,0 соответственно уменьшат уровень звука.

См. также:: getVolume(), setVolume(double)

Баланс

public DoubleProperty balanceProperty

Относительные уровни громкости левого и правого каналов клипа. Допустимый диапазон — от -1,0 до 1,0. Значение -1,0 обеспечивает полную громкость левого канала, а правый канал выключается; 0,0 обеспечивает полную громкость для обоих каналов; 1,0 обеспечивает полную громкость правого канала, а левый канал выключается. Значения вне этого диапазона ограничены внутри.

См. также:: getBalance(), setBalance(double)

Скорость

public DoubleProperty rateProperty

Относительная скорость воспроизведения клипа. Допустимый диапазон — от 0,125 (1/8 скорости) до 8,0 (8-кратная скорость); значения вне этого диапазона ограничены внутри. Нормальное воспроизведение клипа — 1,0; любое другое значение скорости повлияет на высоту тона и продолжительность соответственно.

См. также:: getRate(), setRate(double)

Панорамирование

public DoubleProperty panProperty

Относительное «центральное положение» клипа. Значение панорамирования 0,0 воспроизводит клип обычно, а значение -1,0 смещает клип полностью влево, а 1,0 — полностью вправо. В отличие от баланса, это значение смешивает оба канала, поэтому ни один канал не теряет данных. Установка панорамирования на моно-клип имеет тот же эффект, что и установка баланса, но с гораздо большей стоимостью для ЦП, поэтому это не рекомендуется для моно-клипов.

См. также:: getPan(), setPan(double)

Приоритет

public IntegerProperty priorityProperty

Относительный приоритет клипа по отношению к другим клипам. Это значение используется для определения клипов, которые нужно удалить, когда максимальное количество разрешенных клипов превышено. Чем ниже приоритет, тем больше вероятность, что клип будет остановлен и удален из канала микшера, в котором он находится. Допустимый диапазон — любое целое число; ограничений нет. По умолчанию приоритет всех клипов равен нулю до изменения. Количество одновременных звуков, которые можно воспроизводить, зависит от реализации и, возможно, от системы.

См. также:: getPriority(), setPriority(int)

Количество циклов

public IntegerProperty cycleCountProperty

Количество раз, которое будет воспроизводиться клип, когда вызывается play(). Значение cycleCount, равное 1, воспроизводит клип ровно один раз; значение cycleCount, равное 2, воспроизводит клип дважды и так далее. Допустимый диапазон — 1 или более, но установка этого значения на INDEFINITE заставит клип непрерывно повторяться, пока не будет вызвано stop().

См. также:: getCycleCount(), setCycleCount(int)

Подробности поля

БЕСКОНЕЧНО

public static final int INDEFINITE

Когда cycleCount устанавливается на это значение, AudioClip будет повторяться непрерывно до остановки. Это значение эквивалентно MediaPlayer.INDEFINITE и Animation.INDEFINITE; эти значения могут использоваться взаимозаменяемо.

См. также:: Значения константных полей

Подробности конструктора

AudioClip

public AudioClip(String source)

Создает AudioClip, загруженный по предоставленному URL-адресу.

Параметры:: source — строка URL-адреса для загрузки аудиоклипа. Это может быть источник HTTP, HTTPS, FILE или JAR.
Исключение:: NullPointerException — если параметр является null.; IllegalArgumentException — если параметр нарушает RFC 2396.; MediaException — если возникает другая проблема с загрузкой медиаданных.

Подробности метода

getSource

public String getSource()

Получить URL-адрес источника, использованного для создания этого AudioClip.

Возвращает:: URL-адрес источника, предоставленный конструктору

setVolume

public final void setVolume(double value)

Установить значение громкости по умолчанию. Новое значение вступит в силу только при последующих воспроизведениях.

Параметры:: value — новое значение громкости по умолчанию для этого клипа
См. также:: volumeProperty()

getVolume

public final double getVolume()

Получить значение громкости по умолчанию.

Возвращает:: значение громкости по умолчанию для этого клипа
См. также:: volumeProperty()

volumeProperty

public DoubleProperty volumeProperty()

См. также:: getVolume(), setVolume(double)

setBalance

public void setBalance(double balance)

Установить значение баланса по умолчанию. Новое значение повлияет только на последующие воспроизведения.

Параметры:: balance — новое значение баланса
См. также:: balanceProperty()

getBalance

public double getBalance()

Получить значение баланса по умолчанию для этого клипа.

Возвращает:: значение баланса по умолчанию для этого клипа
См. также:: balanceProperty()

balanceProperty

public DoubleProperty balanceProperty()

См. также:: getBalance(), setBalance(double)

setRate

public void setRate(double rate)

Установить скорость воспроизведения по умолчанию. Новое значение повлияет только на последующие воспроизведения.

Параметры:: rate — новая скорость воспроизведения по умолчанию
См. также:: rateProperty()

getRate

public double getRate()

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

Возвращает:: скорость воспроизведения по умолчанию для этого клипа
См. также:: rateProperty()

rateProperty

public DoubleProperty rateProperty()

См. также:: getRate(), setRate(double)

setPan

public void setPan(double pan)

Установить значение панорамирования по умолчанию. Новое значение повлияет только на последующие воспроизведения.

Параметры:: pan — новое значение панорамирования по умолчанию
См. также:: panProperty()

getPan

public double getPan()

Получить значение панорамирования по умолчанию.

Возвращает:: значение панорамирования по умолчанию для этого клипа
См. также:: panProperty()

panProperty

public DoubleProperty panProperty()

См. также:: getPan(), setPan(double)

setPriority

public void setPriority(int priority)

Установить приоритет воспроизведения по умолчанию. Новое значение повлияет только на последующие воспроизведения.

Параметры:: priority — новый приоритет воспроизведения по умолчанию
См. также:: priorityProperty()

END_OF_DOCUMENT_MARKER

getPriority

public int getPriority()

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

Возвращает:: приоритет воспроизведения по умолчанию для этого фрагмента
См. также:: priorityProperty()

priorityProperty

public IntegerProperty priorityProperty()

Относительный приоритет фрагмента по отношению к другим фрагментам. Это значение используется для определения, какие фрагменты нужно удалить, когда превышено максимальное допустимое количество фрагментов. Чем ниже приоритет, тем выше вероятность того, что фрагмент будет остановлен и удален из канала микшера, который он занимает. Действительный диапазон — любые целые числа; ограничений нет. По умолчанию приоритет всех фрагментов равен нулю, пока он не изменится. Количество одновременно воспроизводимых звуков зависит от реализации и, возможно, от системы.

См. также:: getPriority(), setPriority(int)

setCycleCount

public void setCycleCount(int count)

Установить значение счётчика циклов по умолчанию. Новое значение повлияет только на последующие воспроизведения.

Параметры:: count - новое значение счётчика циклов по умолчанию для этого фрагмента
См. также:: cycleCountProperty()

getCycleCount

public int getCycleCount()

Получить значение счётчика циклов по умолчанию.

Возвращает:: значение счётчика циклов по умолчанию для этого аудиофрагмента
См. также:: cycleCountProperty()

cycleCountProperty

public IntegerProperty cycleCountProperty()

Количество раз, которое фрагмент будет воспроизведён, когда вызывается play(). Значение cycleCount, равное 1, воспроизводит фрагмент один раз, значение 2 — дважды и так далее. Действительный диапазон — 1 и более, но установка значения INDEFINITE заставит фрагмент продолжать циклическое воспроизведение до тех пор, пока не будет вызван stop().

См. также:: getCycleCount(), setCycleCount(int)

play

public void play()

Воспроизвести AudioClip с использованием всех параметров по умолчанию.

play

public void play(double volume)

Воспроизвести AudioClip с использованием всех параметров по умолчанию, за исключением громкости. Этот метод не изменяет параметры по умолчанию фрагмента.

Параметры:: volume - уровень громкости, на котором следует воспроизвести фрагмент

play

public void play(double volume, double balance, double rate, double pan, int priority)

Воспроизвести AudioClip с указанными параметрами. Значения, выходящие за пределы диапазонов, определённых связанными свойствами, будут ограничены. Этот метод не изменяет параметры по умолчанию фрагмента.

Параметры:: volume - Уровень громкости, на котором следует воспроизвести этот фрагмент. Допустимый диапазон громкости от 0,0 до 1,0, где 0,0 соответствует выключению звука, а 1,0 — полной громкости.; balance - Баланс левого/правого канала или относительные громкости каналов для стереоэффектов.; rate - Множитель скорости воспроизведения. 1,0 соответствует нормальной скорости, а 2,0 — удвоению скорости.; pan - Смещение левого/правого канала, применяемое к фрагменту. Значение панорамирования -1,0 означает полный левый канал, 1,0 — полный правый канал, 0,0 не влияет.; priority - Приоритет аудиоэффекта. Эффекты с более низким приоритетом будут отброшены первыми, если слишком много эффектов пытаются играть одновременно.

isPlaying

public boolean isPlaying()

Указывает, воспроизводится ли этот AudioClip. Если это возвращает true, то play() был вызван как минимум один раз и всё ещё воспроизводится.

Возвращает:: true, если этот фрагмент находится в очереди в каком-либо канале микшера, иначе false

stop

public void stop()

Немедленно остановить всё воспроизведение этого AudioClip.

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.