Класс AudioClip

java.lang.Object

fx.scene.media.AudioClip

public final class AudioClip extends Object

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

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


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

Since:: JavaFX 2.0

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

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

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

Модификатор и тип	Поле	Описание
`static final 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`.
`final 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)`	Установить скорость воспроизведения по умолчанию.
`final 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 соответствующим образом уменьшат уровень звука.

См. также:

баланс

public DoubleProperty balanceProperty

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

См. также:

скорость

public DoubleProperty rateProperty

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

См. также:

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

public DoubleProperty panProperty

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

См. также:

приоритет

public IntegerProperty priorityProperty

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

См. также:

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

public IntegerProperty cycleCountProperty

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

См. также:

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

БЕСКОНЕЧНО

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 - новый уровень громкости по умолчанию для этого клипа

См. также:

getVolume

public final double getVolume()

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

Возвращает:

уровень громкости по умолчанию для этого клипа

См. также:

volumeProperty

public DoubleProperty volumeProperty()

Возвращает:

свойство уровня громкости

См. также:

setBalance

public void setBalance(double balance)

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

Параметры:

balance - новый баланс по умолчанию

См. также:

getBalance

public double getBalance()

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

Возвращает:

баланс по умолчанию для этого клипа

См. также:

balanceProperty

public DoubleProperty balanceProperty()

Возвращает:

свойство баланса

См. также:

setRate

public void setRate(double rate)

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

Параметры:

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

См. также:

getRate

public double getRate()

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

Возвращает:

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

См. также:

скоростьВоспроизведения

public DoubleProperty rateProperty()

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

Возвращает:

свойство rate

См. также:

установитьСтереоположение

public void setPan(double pan)

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

Параметры:

pan — новое значение по умолчанию для стереоположения

См. также:

получитьСтереоположение

public double getPan()

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

Возвращает:

значение стереоположения по умолчанию для этого клипа

См. также:

свойствоСтереоположения

public DoubleProperty panProperty()

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

Возвращает:

свойство pan

См. также:

установитьПриоритет

public void setPriority(int priority)

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

Параметры:

priority — новый приоритет воспроизведения по умолчанию

См. также:

получитьПриоритет

public int getPriority()

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

Возвращает:

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

См. также:

свойствоПриоритета

public IntegerProperty priorityProperty()

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

Возвращает:

свойство priority

См. также:

установитьКоличествоЦиклов

public void setCycleCount(int count)

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

Параметры:

count — новое значение количества циклов для этого клипа

См. также:

получитьКоличествоЦиклов

public int getCycleCount()

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

Возвращает:

значение количества циклов по умолчанию для этого аудиоклипа

См. также:

свойствоКоличествоЦиклов

public IntegerProperty cycleCountProperty()

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

Возвращает:

свойство cycleCount

См. также:

воспроизвести

public void play()

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

воспроизвести

public void play(double volume)

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

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

воспроизвести

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 — Приоритет аудиоэффекта. Эффекты с более низким приоритетом будут отброшены первыми, если слишком много эффектов пытаются играть одновременно.

воспроизводится

public boolean isPlaying()

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

Возвращает:: true, если любой канал микшера имеет этот клип в очереди, иначе false

остановить

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.