Spec-Zone.ru › OpenJavaFX 21

Класс 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();
С момента:
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

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

volume

public DoubleProperty volumeProperty
Уровень громкости клипа. Допустимый диапазон значений — от 0.0 (выключено) до 1.0 (полная громкость). Значения вне этого диапазона будут ограничены интернально, поэтому они не будут иметь дополнительного эффекта. Громкость регулируется затуханием, поэтому значения ниже 1.0 соответсвенно уменьшат уровень звука.
См. также:
  • getVolume()
  • setVolume(double)
  • volumeProperty()

balance

public DoubleProperty balanceProperty
Относительные уровни громкости левого и правого каналов клипа. Допустимый диапазон — от -1.0 до 1.0, где -1.0 обеспечивает полную громкость левого канала и выключает правый, 0.0 обеспечивает полную громкость для обоих каналов, а 1.0 — полную громкость правого канала и выключает левый. Значения за пределами этого диапазона ограничены интернально.
См. также:
  • getBalance()
  • setBalance(double)
  • balanceProperty()

rate

public DoubleProperty rateProperty
Относительная скорость воспроизведения клипа. Допустимый диапазон — от 0.125 (1/8 скорости) до 8.0 (8x скорости); значения вне этого диапазона ограничены интернально. Нормальное воспроизведение клипа — 1.0; любая другая скорость повлияет на высоту звука и продолжительность соответственно.
См. также:
  • getRate()
  • setRate(double)
  • rateProperty()

pan

public DoubleProperty panProperty
Относительное "положение" клипа по центру. Значение панорамирования 0.0 воспроизводит клип в обычном режиме, -1.0 смещает клип полностью влево, а 1.0 — полностью вправо. В отличие от баланса, эта настройка смешивает оба канала, так что ни один из каналов не теряет данные. Установка панорамирования для моно-клипа имеет тот же эффект, что и установка баланса, но с гораздо большей нагрузкой на ЦП, поэтому это не рекомендуется для моно-клипов.
См. также:
  • getPan()
  • setPan(double)
  • panProperty()

priority

public IntegerProperty priorityProperty
Относительный приоритет клипа по отношению к другим клипам. Это значение используется для определения клипов, которые нужно удалить, когда превышено максимальное количество разрешенных клипов. Чем ниже приоритет, тем больше вероятность, что клип будет остановлен и удален из канала микшера, который он занимает. Допустимый диапазон — любое целое число; ограничений нет. По умолчанию приоритет всех клипов равен нулю, пока не будет изменён. Количество одновременных звуков, которые могут быть воспроизведены, зависит от реализации и, возможно, от системы.
См. также:
  • getPriority()
  • setPriority(int)
  • priorityProperty()

cycleCount

public IntegerProperty cycleCountProperty
Количество раз, которое будет воспроизводиться клип при вызове play(). cycleCount, равный 1, воспроизводит клип ровно один раз, cycleCount, равный 2, — дважды и так далее. Допустимый диапазон — 1 или более, но установка значения INDEFINITE заставит клип бесконечно циклически воспроизводиться до вызова stop().
См. также:
  • getCycleCount()
  • setCycleCount(int)
  • cycleCountProperty()

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

INDEFINITE

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()
Уровень громкости клипа. Допустимый диапазон значений — от 0.0 (выключено) до 1.0 (полная громкость). Значения вне этого диапазона будут ограничены интернально, поэтому они не будут иметь дополнительного эффекта. Громкость регулируется затуханием, поэтому значения ниже 1.0 соответсвенно уменьшат уровень звука.
Возвращает:
свойство volume
См. также:
  • getVolume()
  • setVolume(double)

setBalance

public void setBalance(double balance)
Установить уровень баланса по умолчанию. Новое значение повлияет только на последующие воспроизведения.
Параметры:
balance — новое значение баланса по умолчанию
См. также:
  • balanceProperty()

getBalance

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

balanceProperty

public DoubleProperty balanceProperty()
Относительные уровни громкости левого и правого каналов клипа. Допустимый диапазон — от -1.0 до 1.0, где -1.0 обеспечивает полную громкость левого канала и выключает правый, 0.0 обеспечивает полную громкость для обоих каналов, а 1.0 — полную громкость правого канала и выключает левый. Значения за пределами этого диапазона ограничены интернально.
Возвращает:
свойство balance
См. также:
  • getBalance()
  • setBalance(double)

setRate

public void setRate(double rate)
Установить скорость воспроизведения по умолчанию. Новое значение повлияет только на последующие воспроизведения.
Параметры:
rate — новая скорость воспроизведения по умолчанию
См. также:
  • rateProperty()

getRate

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

rateProperty

public DoubleProperty rateProperty()
Относительная скорость воспроизведения клипа. Допустимый диапазон — от 0.125 (1/8 скорости) до 8.0 (8x скорости); значения вне этого диапазона ограничены интернально. Нормальное воспроизведение клипа — 1.0; любая другая скорость повлияет на высоту звука и продолжительность соответственно.
Возвращает:
свойство rate
См. также:
  • getRate()
  • setRate(double)

setPan

public void setPan(double pan)
Установить значение панорамирования по умолчанию. Новое значение повлияет только на последующие воспроизведения.
Параметры:
pan — новое значение панорамирования по умолчанию
См. также:
  • panProperty()

getPan

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

panProperty

public DoubleProperty panProperty()
Относительное «центральное» положение клипа. Значение панорамирования 0.0 воспроизводит клип нормально, -1.0 смещает клип полностью влево, а 1.0 — полностью вправо. В отличие от баланса, это значение смешивает оба канала, поэтому данные ни из одного канала не теряются. Установка панорамирования для моно-клипа имеет тот же эффект, что и установка баланса, но с гораздо большей стоимостью в плане нагрузки на ЦП, поэтому это не рекомендуется для моно-клипов.
Возвращает:
свойство pan
См. также:
  • getPan()
  • setPan(double)

setPriority

public void setPriority(int priority)
Установить приоритет воспроизведения по умолчанию. Новое значение будет влиять только на последующие воспроизведения.
Параметры:
priority — новый приоритет воспроизведения по умолчанию
См. также:
  • priorityProperty()

getPriority

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

priorityProperty

public IntegerProperty priorityProperty()
Относительный приоритет клипа по отношению к другим клипам. Это значение используется для определения клипов, которые следует удалить, когда достигнуто максимальное допустимое количество клипов. Чем ниже приоритет, тем выше вероятность того, что клип будет остановлен и удален из канала микшера, который он занимает. Допустимый диапазон — любое целое число; ограничений нет. Приоритет по умолчанию для всех клипов равен нулю, пока не будет изменено. Количество одновременно воспроизводимых звуков зависит от реализации и, возможно, от системы.
Возвращает:
свойство priority
См. также:
  • getPriority()
  • setPriority(int)

setCycleCount

public void setCycleCount(int count)
Установить значение счетчика циклов по умолчанию. Новое значение будет влиять только на последующие воспроизведения.
Параметры:
count — новое значение счетчика циклов по умолчанию для этого клипа
См. также:
  • cycleCountProperty()

getCycleCount

public int getCycleCount()
Получить значение счетчика циклов по умолчанию.
Возвращает:
значение счетчика циклов по умолчанию для этого аудио клипа
См. также:
  • cycleCountProperty()

cycleCountProperty

public IntegerProperty cycleCountProperty()
Количество раз, которое клип будет воспроизведён при вызове play(). Значение cycleCount 1 воспроизводит клип один раз, cycleCount 2 — дважды и так далее. Допустимый диапазон — 1 или больше, но установка этого значения на INDEFINITE заставит клип продолжать воспроизводиться в цикле до тех пор, пока не будет вызван stop().
Возвращает:
свойство cycleCount
См. также:
  • 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API