Класс MediaPlayer
- javafx.scene.media.MediaPlayer
public final class MediaPlayer extends Object
MediaPlayer предоставляет средства управления воспроизведением медиа. Он используется совместно с классами Media и MediaView для отображения и управления воспроизведением медиа. MediaPlayer не содержит визуальных элементов, поэтому для просмотра видео необходимо использовать класс MediaView. MediaPlayer предоставляет средства управления pause(), play(), stop() и seek(), а также свойства rate и autoPlay, которые применяются ко всем типам медиа. Он также предоставляет свойства balance, mute и volume для управления характеристиками аудиовоспроизведения. Более тонкий контроль качества звука можно получить через AudioEqualizer, связанный с плеером. Отобразить частотные характеристики аудио можно, зарегистрировав AudioSpectrumListener. Информацию о позиции воспроизведения, скорости и буферизации можно получить из свойств currentTime, currentRate и bufferProgressTime соответственно. Уведомления о маркерах медиа принимаются обработчиком событий, зарегистрированным как свойство onMarker.
Для медиа с конечной длительностью воспроизведение может быть позиционировано в любой момент времени между 0.0 и продолжительностью медиа. MediaPlayer уточняет это определение, добавив свойства startTime и stopTime, которые фактически определяют виртуальный источник медиа с позицией во времени, ограниченной [startTime,stopTime]. Воспроизведение медиа начинается с startTime и продолжается до stopTime. Интервал, определяемый этими двумя конечными точками, называется циклом, длительность которого равна разнице между временем окончания и начала. Этот цикл может повторяться определённое или неопределённое количество раз. Общая продолжительность воспроизведения медиа затем является произведением длительности цикла и количества раз, которое цикл воспроизводится. Если время окончания цикла достигнуто, и цикл должен быть воспроизведён снова, вызывается обработчик событий, зарегистрированный в свойстве onRepeat. Если время окончания достигнуто, и цикл не должен повторяться, вызывается обработчик событий, зарегистрированный в свойстве onEndOfMedia. Нулевой индекс, обозначающий текущий цикл, поддерживается currentCount.
Работа MediaPlayer по своей природе асинхронна. Плеер не готов ответить на команды квази-немедленно, пока его состояние не перейдёт в MediaPlayer.Status.READY, что, как правило, происходит после завершения предварительного проигрывания медиа. Однако некоторые запросы к плееру до перехода в состояние READY будут выполнены после перехода. Это включает вызов play() без промежуточного вызова pause() или stop() до перехода READY, а также установку любого из свойств autoPlay, balance, mute, rate, startTime, stopTime и volume.
Свойство status может отслеживаться, чтобы приложение знало о изменениях состояния плеера, и функции обратного вызова могут быть зарегистрированы через свойства, такие как onReady, если необходимо выполнить какое-либо действие при входе в определённое состояние. Также есть свойства error и onError, которые соответственно позволяют отслеживать появление ошибок и выполнять заданное действие в ответ.
Один и тот же объект MediaPlayer может быть использован несколькими MediaView. Это никак не повлияет на сам плеер. В частности, настройки свойств представления не повлияют на воспроизведение медиа.
-
Краткое описание свойств
Все методыМетоды экземпляраКонкретные методы Тип Свойство и описание DoublePropertyaudioSpectrumIntervalИнтервал между обновлениями спектра в секундах.ObjectProperty<AudioSpectrumListener>audioSpectrumListenerПрослушиватель обновлений аудиоспектра.IntegerPropertyaudioSpectrumNumBandsКоличество полос в аудиоспектре.IntegerPropertyaudioSpectrumThresholdПорог чувствительности в децибелах; должен быть не положительным.BooleanPropertyautoPlayНачинать воспроизведение как можно скорее.DoublePropertybalanceБаланс или лево-право установка аудиовыхода.ReadOnlyObjectProperty<Duration>bufferProgressTimeТекущая позиция буфера, показывающая, сколько медиа можно воспроизвести без остановкиMediaPlayer.ReadOnlyIntegerPropertycurrentCountКоличество завершённых циклов воспроизведения.ReadOnlyDoublePropertycurrentRateТекущая скорость воспроизведения независимо от настроек.ReadOnlyObjectProperty<Duration>currentTimeТекущее время воспроизведения медиа.IntegerPropertycycleCountКоличество раз, которое медиа будет воспроизводиться.ReadOnlyObjectProperty<Duration>cycleDurationReadOnlyObjectProperty<MediaException>errorНаблюдаемое свойство, установленное наMediaException, если произошла ошибка.BooleanPropertymuteВыключен ли звук плеера.ObjectProperty<Runnable>onEndOfMediaОбработчик событий, вызываемый, когда плеерcurrentTimeдостигаетstopTime.ObjectProperty<Runnable>onErrorОбработчик событий, вызываемый при возникновении ошибки.ObjectProperty<Runnable>onHaltedОбработчик событий, вызываемый, когда состояние меняется наHALTED.ObjectProperty<EventHandler<MediaMarkerEvent>>onMarkerОбработчик событий, вызываемый, когда плеерcurrentTimeдостигает отметки медиа.ObjectProperty<Runnable>onPausedОбработчик событий, вызываемый, когда состояние меняется наPAUSED.ObjectProperty<Runnable>onPlayingОбработчик событий, вызываемый, когда состояние меняется наPLAYING.ObjectProperty<Runnable>onReadyОбработчик событий, вызываемый, когда состояние меняется наREADY.ObjectProperty<Runnable>onRepeatОбработчик событий, вызываемый, когда плеерcurrentTimeдостигаетstopTimeи будет повторяться.ObjectProperty<Runnable>onStalledОбработчик событий, вызываемый, когда состояние меняется наSTALLED.ObjectProperty<Runnable>onStoppedОбработчик событий, вызываемый, когда состояние меняется наSTOPPED.DoublePropertyrateСкорость воспроизведения медиа.ObjectProperty<Duration>startTimeСмещение времени, с которого должно начаться воспроизведение медиа или возобновление с начала при повторении.ReadOnlyObjectProperty<MediaPlayer.Status>statusТекущее состояние MediaPlayer.ObjectProperty<Duration>stopTimeСмещение времени, на котором воспроизведение медиа должно остановиться или перезапуститься при повторении.ReadOnlyObjectProperty<Duration>totalDurationОбщее время воспроизведения, если разрешено воспроизведение до конца.DoublePropertyvolumeГромкость, с которой должно воспроизводиться медиа.
-
Краткое описание вложенных классов
Вложенные классы Модификатор и тип Класс и описание static classMediaPlayer.StatusПеречисление, описывающее различные значения состоянияMediaPlayer.
-
Краткое описание полей
Поля Модификатор и тип Поле и описание static intINDEFINITEЗначение, представляющее эффективно бесконечное число циклов воспроизведения.
-
Краткое описание конструкторов
Конструкторы Конструктор и описание MediaPlayer(Media media)Создать плеер для определённого медиа.
-
Краткое описание методов
Все методыМетоды экземпляровКонкретные методы Модификатор и тип Метод и описание DoublePropertyaudioSpectrumIntervalProperty()Интервал обновления спектра в секундах.ObjectProperty<AudioSpectrumListener>audioSpectrumListenerProperty()Прослушиватель обновлений аудиоспектра.IntegerPropertyaudioSpectrumNumBandsProperty()Количество полос в аудиоспектре.IntegerPropertyaudioSpectrumThresholdProperty()Пороговое значение чувствительности в децибелах; должно быть неположительным.BooleanPropertyautoPlayProperty()Начать воспроизведение как можно скорее.DoublePropertybalanceProperty()Баланс или настройка лево-право аудиовыхода.ReadOnlyObjectProperty<Duration>bufferProgressTimeProperty()Текущая позиция буфера, указывающая, сколько медиа можно воспроизвести без остановкиMediaPlayer.ReadOnlyIntegerPropertycurrentCountProperty()Количество завершённых циклов воспроизведения.ReadOnlyDoublePropertycurrentRateProperty()Текущая скорость воспроизведения независимо от настроек.ReadOnlyObjectProperty<Duration>currentTimeProperty()Текущее время воспроизведения медиа.IntegerPropertycycleCountProperty()Количество раз, которое будет воспроизведено медиа.ReadOnlyObjectProperty<Duration>cycleDurationProperty()voiddispose()Освободить все ресурсы, связанные с плеером.ReadOnlyObjectProperty<MediaException>errorProperty()Наблюдаемая свойство, установленное наMediaException, если произошла ошибка.AudioEqualizergetAudioEqualizer()Получить связанный с этим плееромAudioEqualizer.doublegetAudioSpectrumInterval()Получить значение интервала уведомления о спектре аудио в секундах.AudioSpectrumListenergetAudioSpectrumListener()Получить прослушивателя аудиоспектра.intgetAudioSpectrumNumBands()Получить количество полос в аудиоспектре.intgetAudioSpectrumThreshold()Получить порог аудиоспектра в децибелах.doublegetBalance()Получить баланс аудио.DurationgetBufferProgressTime()Получить значениеbufferProgressTime.intgetCurrentCount()Получить индекс текущего цикла.doublegetCurrentRate()Получить текущую скорость воспроизведения.DurationgetCurrentTime()Получить текущее время медиа.intgetCycleCount()Получить количество циклов.DurationgetCycleDuration()Получить длительность цикла в секундах.MediaExceptiongetError()Получить значение свойстваerrorилиnull, если ошибка отсутствует.MediagetMedia()Получить экземплярMedia, который воспроизводится.RunnablegetOnEndOfMedia()Получить обработчик события конца медиа.RunnablegetOnError()Получить обработчик событий ошибок.RunnablegetOnHalted()Получить обработчик событияMediaPlayer.Status.HALTED.EventHandler<MediaMarkerEvent>getOnMarker()Получить обработчик события метки.RunnablegetOnPaused()Получить обработчик событияMediaPlayer.Status.PAUSED.RunnablegetOnPlaying()Получить обработчик событияMediaPlayer.Status.PLAYING.RunnablegetOnReady()Получить обработчик событияMediaPlayer.Status.READY.RunnablegetOnRepeat()Получить обработчик события повтора.RunnablegetOnStalled()Получить обработчик событияMediaPlayer.Status.STALLED.RunnablegetOnStopped()Получить обработчик событияMediaPlayer.Status.STOPPED.doublegetRate()Получить скорость воспроизведения.DurationgetStartTime()Получить начальное время.MediaPlayer.StatusgetStatus()Получить текущий статус плеера.DurationgetStopTime()Получить время остановки.DurationgetTotalDuration()Получить общую продолжительность воспроизведения, включая все циклы (повторения).doublegetVolume()Получить громкость аудиовоспроизведения.booleanisAutoPlay()Получить значение свойстваautoPlay.booleanisMute()Получить значениеmuteProperty().BooleanPropertymuteProperty()Будет ли аудио плеера выключено.ObjectProperty<Runnable>onEndOfMediaProperty()Обработчик событий, вызываемый, когда игрокcurrentTimeдостигаетstopTime.ObjectProperty<Runnable>onErrorProperty()Обработчик событий, вызываемый при возникновении ошибки.ObjectProperty<Runnable>onHaltedProperty()Обработчик событий, вызываемый при изменении статуса наHALTED.ObjectProperty<EventHandler<MediaMarkerEvent>>onMarkerProperty()Обработчик событий, вызываемый, когда игрокcurrentTimeдостигает метки медиа.ObjectProperty<Runnable>onPausedProperty()Обработчик событий, вызываемый при изменении статуса наPAUSED.ObjectProperty<Runnable>onPlayingProperty()Обработчик событий, вызываемый при изменении статуса наPLAYING.ObjectProperty<Runnable>onReadyProperty()Обработчик событий, вызываемый при изменении статуса наREADY.ObjectProperty<Runnable>onRepeatProperty()Обработчик событий, вызываемый, когда игрокcurrentTimeдостигаетstopTimeи будет повторять.ObjectProperty<Runnable>onStalledProperty()Обработчик событий, вызываемый при изменении статуса наSTALLED.ObjectProperty<Runnable>onStoppedProperty()Обработчик событий, вызываемый при изменении статуса наSTOPPED.voidpause()Приостанавливает плеер.voidplay()Начинает воспроизведение медиа.DoublePropertyrateProperty()Скорость воспроизведения медиа.voidseek(Duration seekTime)Перемещает плеер к новому времени воспроизведения.voidsetAudioSpectrumInterval(double value)Устанавливает значение интервала уведомления о спектре аудио в секундах.voidsetAudioSpectrumListener(AudioSpectrumListener listener)Устанавливает прослушивателя аудиоспектра.voidsetAudioSpectrumNumBands(int value)Устанавливает количество полос в аудиоспектре.voidsetAudioSpectrumThreshold(int value)Устанавливает порог аудиоспектра в децибелах.voidsetAutoPlay(boolean value)Устанавливает значение свойстваautoPlay.voidsetBalance(double value)Устанавливает баланс аудио.voidsetCycleCount(int value)Устанавливает количество циклов.voidsetMute(boolean value)Устанавливает значениеmuteProperty().
voidsetOnEndOfMedia(Runnable value)Устанавливает обработчик события завершения воспроизведения.voidsetOnError(Runnable value)Устанавливает обработчик события возникновения ошибки.voidsetOnHalted(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.HALTED.voidsetOnMarker(EventHandler<MediaMarkerEvent> onMarker)Устанавливает обработчик события метки.voidsetOnPaused(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.PAUSED.voidsetOnPlaying(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.PLAYING.voidsetOnReady(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.READY.voidsetOnRepeat(Runnable value)Устанавливает обработчик события повтора.voidsetOnStalled(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.STALLED.voidsetOnStopped(Runnable value)Устанавливает обработчик событияMediaPlayer.Status.STOPPED.voidsetRate(double value)Устанавливает скорость воспроизведения на заданное значение.voidsetStartTime(Duration value)Устанавливает начальное время.voidsetStopTime(Duration value)Устанавливает конечное время.voidsetVolume(double value)Устанавливает громкость аудиовоспроизведения.ObjectProperty<Duration>startTimeProperty()Смещение времени, с которого должно начаться воспроизведение медиа или с которого должно начаться повтор.ReadOnlyObjectProperty<MediaPlayer.Status>statusProperty()Текущее состояние MediaPlayer.voidstop()Останавливает воспроизведение медиа.ObjectProperty<Duration>stopTimeProperty()Смещение времени, до которого должно воспроизводиться медиа или с которого должен начаться повтор при повторе.ReadOnlyObjectProperty<Duration>totalDurationProperty()Общее время воспроизведения, если разрешено воспроизведение до конца.DoublePropertyvolumeProperty()Громкость, с которой следует воспроизводить медиа.
-
Подробное описание свойства
-
error
public ReadOnlyObjectProperty<MediaException> errorProperty
Наблюдаемое свойство, устанавливаемое вMediaException, если произошла ошибка.См. также:
-
onError
public ObjectProperty<Runnable> onErrorProperty
Обработчик событий, вызываемый при возникновении ошибки.См. также:
-
autoPlay
public BooleanProperty autoPlayProperty
Указывает, должно ли воспроизведение начинаться как можно скорее. Для нового плеера это произойдёт, когда плеер достигнет состояния READY. Значение по умолчанию —false.См. также:
-
rate
public DoubleProperty rateProperty
Скорость воспроизведения медиа. Например, скорость1.0воспроизводит медиа с обычной (кодированной) скоростью воспроизведения,2.0воспроизводит в два раза быстрее обычной и т. д. В настоящее время поддерживаемый диапазон скоростей —[0.0, 8.0]. Значение по умолчанию —1.0.См. также:
-
currentRate
public ReadOnlyDoubleProperty currentRateProperty
Текущая скорость воспроизведения независимо от настроек. Например, еслиrateустановлено в 1,0, а плеер приостановлен или заблокирован, тоcurrentRateбудет равно нулю.См. также:
-
volume
public DoubleProperty volumeProperty
Громкость воспроизведения медиа. Диапазон эффективных значений —[0.0 1.0], где0.0— не слышно, а1.0— полная громкость, которая является значением по умолчанию.См. также:
-
balance
public DoubleProperty balanceProperty
Баланс или настройка лево-право вывода аудио. Диапазон эффективных значений —[-1.0, 1.0], где-1.0— полная левая,0.0— центр, а1.0— полная правая. Значение по умолчанию —0.0.См. также:
-
startTime
public ObjectProperty<Duration> startTimeProperty
Смещение времени, с которого должно начаться воспроизведение медиа или с которого следует перезапустить при повторении. При остановке воспроизведения текущее время сбрасывается до этого значения. Если это значение положительное, то при первом воспроизведении медиа может произойти задержка перед началом воспроизведения, если позиция воспроизведения не может быть установлена в произвольное время внутри медиа. Это может произойти, например, для видео, которое не содержит таблицы поиска смещений внутрикадровых кадров в потоке видео. В таком случае потребуется пропустить видеокадры до тех пор, пока не будет достигнут первый внутрикадровый кадр перед временем начала. Значение по умолчанию —Duration.ZERO.Ограничения:
0 ≤ startTime <stopTimeСм. также:
-
stopTime
public ObjectProperty<Duration> stopTimeProperty
Смещение времени, на котором воспроизведение медиа должно остановиться или перезапуститься при повторении. Значение по умолчанию —.getMedia().getDuration()Ограничения:
startTime< stopTime ≤Media.durationСм. также:
-
cycleDuration
public ReadOnlyObjectProperty<Duration> cycleDurationProperty
Промежуток времени междуstartTimeиstopTimeэтого плеера. Для общей продолжительности медиа используйте свойствоMedia.duration.См. также:
-
totalDuration
public ReadOnlyObjectProperty<Duration> totalDurationProperty
Общее время воспроизведения, если разрешено воспроизводить до конца. ЕслиcycleCountустановлено вINDEFINITE, то это значение также будет INDEFINITE. Если продолжительность медиа — UNKNOWN, то и это значение будет UNKNOWN. В противном случае полная продолжительность будет произведением cycleDuration и cycleCount.См. также:
-
currentTime
public ReadOnlyObjectProperty<Duration> currentTimeProperty
Текущее время воспроизведения медиа. Это свойство только для чтения: используйтеseek(javafx.util.Duration)для изменения позиции воспроизведения на другой фрагмент.См. также:
-
status
public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty
Текущее состояние MediaPlayer.См. также:
-
bufferProgressTime
public ReadOnlyObjectProperty<Duration> bufferProgressTimeProperty
Текущая позиция буферизации, указывающая, сколько медиа можно воспроизвести без приостановкиMediaPlayer. Это относится к буферизованным потокам, например, тем, которые читаются из сетевых подключений, а не, например, из локальных файлов.Переход к позиции за пределами
bufferProgressTimeможет вызвать небольшую паузу в воспроизведении до тех пор, пока не будет буферизовано достаточное количество данных, чтобы возобновить воспроизведение.См. также:
-
cycleCount
public IntegerProperty cycleCountProperty
Количество раз, которое будет воспроизводиться медиа. По умолчаниюcycleCountустановлено в1, что означает, что медиа будет воспроизводиться только один раз. УстановкаcycleCountна значение больше 1 приведет к воспроизведению медиа заданное количество раз или до остановки. Если установлено значениеINDEFINITE, воспроизведение будет повторяться до тех пор, пока не будет вызвано stop() или pause().Ограничения:
cycleCount ≥ 1См. также:
-
currentCount
public ReadOnlyIntegerProperty currentCountProperty
Количество завершенных циклов воспроизведения. В первый проход значение должно быть 0. Во второй проход — 1 и так далее. Оно увеличивается в конце каждого цикла непосредственно перед возвращением кstartTime, т. е., когдаstopTimeили конец медиа достигнут.См. также:
-
mute
public BooleanProperty muteProperty
Указывает, заглушен ли звук плеера. Значениеtrueозначает, что звук не воспроизводится. Значение этого свойства не влияет наvolume, т. е., если звук заглушен, а затем раззаглушен, воспроизведение звука продолжится на том же уровне громкости, при условии, что свойствоvolumeне было изменено тем временем. Значение по умолчанию —false.См. также:
-
onMarker
public ObjectProperty<EventHandler<MediaMarkerEvent>> onMarkerProperty
Обработчик событий, вызываемый, когда плеерcurrentTimeдостигает медиа-метки.См. также:
-
onEndOfMedia
public ObjectProperty<Runnable> onEndOfMediaProperty
Обработчик событий, вызываемый, когда плеерcurrentTimeдостигаетstopTime.См. также:
-
onReady
public ObjectProperty<Runnable> onReadyProperty
Обработчик событий, вызываемый, когда состояние меняется наREADY.См. также:
-
onPlaying
public ObjectProperty<Runnable> onPlayingProperty
Обработчик событий, вызываемый, когда состояние меняется наPLAYING.См. также:
-
onPaused
public ObjectProperty<Runnable> onPausedProperty
Обработчик событий, вызываемый, когда состояние меняется наPAUSED.См. также:
-
onStopped
public ObjectProperty<Runnable> onStoppedProperty
Обработчик событий, вызываемый, когда состояние меняется наSTOPPED.См. также:
-
onHalted
public ObjectProperty<Runnable> onHaltedProperty
Обработчик событий, вызываемый, когда состояние меняется наHALTED.См. также:
-
-
onRepeat
public ObjectProperty<Runnable> onRepeatProperty
Обработчик событий, вызываемый, когда проигрывательcurrentTimeдостигаетstopTimeи будет повторяться. Этот обратный вызов выполняется перед возвратом кstartTime.См. также:
-
onStalled
public ObjectProperty<Runnable> onStalledProperty
Обработчик событий, вызываемый, когда состояние изменяется наSTALLED.См. также:
-
audioSpectrumNumBands
public IntegerProperty audioSpectrumNumBandsProperty
Количество полос в спектре аудиосигнала. Значение по умолчанию — 128; минимум — 2. Диапазон частот аудиосигнала будет разделен на указанное количество частотных интервалов. Например, типичный цифровой музыкальный сигнал имеет диапазон частот[0.0, 22050]Гц. Если число спектральных полос в этом случае установить на 10, ширина каждого частотного интервала в спектре составит2205Гц, а нижняя граница самой низкой частоты будет равна0.0.
-
audioSpectrumInterval
public DoubleProperty audioSpectrumIntervalProperty
Интервал обновления спектра в секундах. Значение по умолчанию —0.1секунды.
-
audioSpectrumThreshold
public IntegerProperty audioSpectrumThresholdProperty
Пороговое значение чувствительности в децибелах; должно быть не положительным. Значения ниже этого порога по отношению к пиковой частоте в данной спектральной полосе будут установлены равными значению порога. Значение по умолчанию — -60 дБ.
-
audioSpectrumListener
public ObjectProperty<AudioSpectrumListener> audioSpectrumListenerProperty
Слушатель обновлений спектра аудиосигнала. При регистрации слушателя вычисление спектра аудиосигнала включается; при удалении слушателя вычисление отключается. Может быть зарегистрирован только один слушатель, поэтому если требуется несколько наблюдателей, события должны быть переданы.Слушатель может быть полезен, например, для построения частотного спектра воспроизводимого аудио или генерации волновых форм для визуализации музыки.
-
-
Подробное описание полей
-
INDEFINITE
public static final int INDEFINITE
Значение, представляющее эффективно бесконечное количество циклов воспроизведения. КогдаcycleCountустановлено в это значение, проигрыватель будет воспроизводитьMediaдо остановки или паузы.См. также:
-
-
Подробное описание конструкторов
-
MediaPlayer
public MediaPlayer(Media media)
Создает проигрыватель для определённого медиа. Это единственный способ связать объектMediaс объектомMediaPlayer: после создания проигрыватель изменить нельзя. Ошибки, возникающие синхронно внутри конструктора, вызовут исключения. Ошибки, возникающие асинхронно, приведут к установке свойстваerrorи, следовательно, к вызову любого обратного вызоваonError.При создании свойство
statusпроигрывателя будетMediaPlayer.Status.UNKNOWN. После того, какstatusперейдёт в состояниеMediaPlayer.Status.READY, проигрыватель будет готов к использованию. Время между созданием проигрывателя и переходом в состояниеREADYможет варьироваться в зависимости, например, от того, загружается ли медиа по сетевому соединению или из локальной файловой системы.Параметры:
media— медиа для воспроизведения.Исключения:
NullPointerException— если медиаnull.
-
-
Подробное описание методов
-
getAudioEqualizer
public final AudioEqualizer getAudioEqualizer()
ПолучитьAudioEqualizer, связанный с этим плеером.Возвращает:
AudioEqualizerилиnull, если плеер удален.
-
getError
public final MediaException getError()
Получить значение свойстваerrorилиnull, если ошибка отсутствует.Возвращает:
MediaExceptionилиnull.
-
errorProperty
public ReadOnlyObjectProperty<MediaException> errorProperty()
Наблюдаемое свойство, устанавливаемое вMediaException, если произошла ошибка.См. также:
-
setOnError
public final void setOnError(Runnable value)
Устанавливает обработчик событий, вызываемый при возникновении ошибки.Параметры:
value— обработчик событий илиnull.
-
getOnError
public final Runnable getOnError()
Возвращает обработчик событий для ошибок.Возвращает:
обработчик событий.
-
onErrorProperty
public ObjectProperty<Runnable> onErrorProperty()
Обработчик событий, вызываемый при возникновении ошибки.См. также:
-
getMedia
public final Media getMedia()
Возвращает экземплярMedia, который воспроизводится.Возвращает:
объект
Media.
-
setAutoPlay
public final void setAutoPlay(boolean value)
Устанавливает значение свойстваautoPlay.Параметры:
value— следует ли включить автоматическое воспроизведение
-
isAutoPlay
public final boolean isAutoPlay()
Возвращает значение свойстваautoPlay.Возвращает:
значение.
-
autoPlayProperty
public BooleanProperty autoPlayProperty()
Следует ли начать воспроизведение как можно скорее. Для нового плеера это произойдет после достижения состоянием READY. Значение по умолчанию —false.См. также:
-
play
public void play()
Начинает воспроизведение медиа. Если ранее был приостановлен, воспроизведение возобновляется с места остановки. Если воспроизведение было остановлено, воспроизведение начинается сstartTime. При фактическом начале воспроизведения свойствоstatusбудет установлено в значениеMediaPlayer.Status.PLAYING.
-
pause
public void pause()
Приостанавливает плеер. После фактической приостановки плеера свойствоstatusбудет установлено в значениеMediaPlayer.Status.PAUSED.
-
stop
public void stop()
Останавливает воспроизведение медиа. Эта операция сбрасывает воспроизведение доstartTimeи сбрасываетcurrentCountдо нуля. После фактической остановки плеера свойствоstatusбудет установлено в значениеMediaPlayer.Status.STOPPED. Единственные переходы из состоянияSTOPPED— вMediaPlayer.Status.PAUSEDиMediaPlayer.Status.PLAYING, которые происходят после вызоваpause()илиplay()соответственно. Во время остановки плеер не будет реагировать на изменения позиции воспроизведения, запрошенные методомseek(javafx.util.Duration).
-
setRate
public final void setRate(double value)
Устанавливает скорость воспроизведения в указанное значение. Его эффект будет ограничен диапазоном[0.0, 8.0]. Вызов этого метода не повлияет, если длительность медиаDuration.INDEFINITE.Параметры:
value— скорость воспроизведения
-
getRate
public final double getRate()
Возвращает скорость воспроизведения.Возвращает:
скорость воспроизведения
-
rateProperty
public DoubleProperty rateProperty()
Скорость воспроизведения медиа. Например, скорость1.0воспроизводит медиа с обычной (закодированной) скоростью воспроизведения,2.0воспроизводит в два раза быстрее и т. д. Текущий поддерживаемый диапазон скоростей —[0.0, 8.0]. Значение по умолчанию —1.0.См. также:
-
getCurrentRate
public final double getCurrentRate()
Возвращает текущую скорость воспроизведения.Возвращает:
текущую скорость
-
currentRateProperty
public ReadOnlyDoubleProperty currentRateProperty()
Текущая скорость воспроизведения независимо от настроек. Например, еслиrateустановлено в 1,0, и плеер приостановлен или заблокирован, тоcurrentRateбудет равно нулю.См. также:
-
setVolume
public final void setVolume(double value)
Устанавливает громкость аудиовоспроизведения. Его эффект будет ограничен диапазоном[0.0, 1.0].Параметры:
value— громкость
-
getVolume
public final double getVolume()
Возвращает громкость аудиовоспроизведения. Значение по умолчанию —1.0.Возвращает:
громкость звука
-
volumeProperty
public DoubleProperty volumeProperty()
Громкость, с которой должно воспроизводиться медиа. Диапазон эффективных значений —[0.0 1.0], где0.0— неслышно, а1.0— полная громкость, которая является значением по умолчанию.См. также:
-
setBalance
public final void setBalance(double value)
Устанавливает баланс звука. Его эффект будет ограничен диапазоном[-1.0, 1.0].Параметры:
value— баланс
-
getBalance
public final double getBalance()
Возвращает баланс звука.Возвращает:
баланс звука
-
balanceProperty
public DoubleProperty balanceProperty()
Баланс или настройка лево-право аудиовыхода. Диапазон эффективных значений —[-1.0, 1.0], где-1.0— полная левая,0.0— центральная, а1.0— полная правая. Значение по умолчанию —0.0.См. также:
-
setStartTime
public final void setStartTime(Duration value)
Устанавливает время начала. Его эффект будет ограничен диапазоном[. Вызов этого метода не повлияет, если длительность медиаDuration.ZERO,stopTime)Duration.INDEFINITE.Параметры:
value— время начала
-
getStartTime
public final Duration getStartTime()
Возвращает время начала. Значение по умолчанию —Duration.ZERO.Возвращает:
время начала
-
startTimeProperty
public ObjectProperty<Duration> startTimeProperty()
Смещение времени, с которого должно начаться воспроизведение медиа или с которого нужно перезапускать при повторении. При остановке воспроизведения текущее время сбрасывается до этого значения. Если это значение положительное, то при первом воспроизведении медиа может быть задержка перед началом воспроизведения, если позиция воспроизведения может быть установлена на произвольное время в пределах медиа. Это может произойти, например, для видео, которое не содержит таблицы поиска смещений внутрикадровых кадров в потоке видео. В таком случае необходимо пропустить видеокадры до тех пор, пока не будет достигнут позиция первого внутрикадрового кадра перед временем начала. Значение по умолчанию —Duration.ZERO.Ограничения:
0 ≤ startTime <stopTimeСм. также:
-
setStopTime
public final void setStopTime(Duration value)
Устанавливает время окончания. Его эффект будет ограничен диапазоном(. Вызов этого метода не повлияет, если длительность медиаstartTime,Media.duration]Duration.INDEFINITE.Параметры:
value— время окончания
-
getStopTime
public final Duration getStopTime()
Возвращает время окончания. Значение по умолчанию —. Обратите внимание, чтоgetMedia().getDuration()может иметь значениеMedia.durationDuration.UNKNOWN, если инициализация медиа не завершена.Возвращает:
время окончания
-
stopTimeProperty
public ObjectProperty<Duration> stopTimeProperty()
Смещение времени, до которого должно воспроизводиться медиа или с которого нужно перезапускать при повторении. Значение по умолчанию —.getMedia().getDuration()Ограничения:
startTime< stopTime ≤Media.durationСм. также:
-
getCycleDuration
public final Duration getCycleDuration()
Возвращает длительность цикла в секундах.Возвращает:
длительность цикла
-
-
cycleDurationProperty
public ReadOnlyObjectProperty<Duration> cycleDurationProperty()
Продолжительность цикла междуstartTimeиstopTimeэтого плеера. Для общей длительности медиа используйте свойствоMedia.duration.См. также:
-
getTotalDuration
public final Duration getTotalDuration()
Возвращает общую длительность воспроизведения, включая все циклы (повторения).Возвращает:
общая длительность воспроизведения
-
totalDurationProperty
public ReadOnlyObjectProperty<Duration> totalDurationProperty()
Общая продолжительность воспроизведения, если разрешено воспроизведение до конца. ЕслиcycleCountустановлено вINDEFINITE, то это также будет БЕСКОНЕЧНО. Если длительность медиа UNKNOWN, то и общая длительность будет UNKNOWN. В противном случае, общая длительность будет произведением cycleDuration и cycleCount.См. также:
-
getCurrentTime
public final Duration getCurrentTime()
Возвращает текущее время медиа.Возвращает:
текущее время медиа
-
currentTimeProperty
public ReadOnlyObjectProperty<Duration> currentTimeProperty()
Текущее время воспроизведения медиа. Это свойство является только для чтения: для изменения позиции воспроизведения используйтеseek(javafx.util.Duration).См. также:
-
seek
public void seek(Duration seekTime)
Перемещает плеер к новому времени воспроизведения. Вызов этого метода не окажет никакого влияния, пока состояние плеераMediaPlayer.Status.STOPPEDили длительность медиаDuration.INDEFINITE.Поведение
seek()ограничено следующим образом, где начальное время и конечное время указывают соответственно эффективные нижние и верхние границы воспроизведения медиа:seekTime позиция перехода nullбез изменений Duration.UNKNOWNбез изменений Duration.INDEFINITEконечное время seekTime < начальное время начальное время seekTime > конечное время конечное время начальное время ≤ seekTime ≤ конечное время seekTime Параметры:
seekTime- запрашиваемое время воспроизведения
-
getStatus
public final MediaPlayer.Status getStatus()
Возвращает текущее состояние плеера.Возвращает:
состояние воспроизведения
-
statusProperty
public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty()
Текущее состояние MediaPlayer.См. также:
-
getBufferProgressTime
public final Duration getBufferProgressTime()
Возвращает значениеbufferProgressTime.Возвращает:
время прогресса буферизации
-
bufferProgressTimeProperty
public ReadOnlyObjectProperty<Duration> bufferProgressTimeProperty()
Текущая позиция буфера, указывающая, сколько медиа можно воспроизвести без остановкиMediaPlayer. Это применимо к буферизованным потокам, таким как те, которые считываются из сетевых подключений, а не, например, из локальных файлов.Переход к позиции, превышающей
bufferProgressTime, может вызвать небольшую паузу в воспроизведении до тех пор, пока не будет буферизован объем данных, достаточный для возобновления воспроизведения.См. также:
-
setCycleCount
public final void setCycleCount(int value)
Устанавливает количество циклов. Его эффект будет ограничен[1,. Вызов этого метода не окажет никакого влияния, если длительность медиаInteger.MAX_VALUE]Duration.INDEFINITE.Параметры:
value- количество циклов
-
getCycleCount
public final int getCycleCount()
Возвращает количество циклов.Возвращает:
количество циклов.
-
cycleCountProperty
public IntegerProperty cycleCountProperty()
Количество раз, которое будет воспроизводиться медиа. По умолчанию,cycleCountустановлено в1, что означает, что медиа будет воспроизведено только один раз. УстановкаcycleCountна значение больше 1 приведет к воспроизведению медиа заданное количество раз или до остановки. Если установлено вINDEFINITE, воспроизведение будет повторяться до тех пор, пока не будет вызван stop() или pause().ограничения:
cycleCount ≥ 1См. также:
-
getCurrentCount
public final int getCurrentCount()
Возвращает индекс текущего цикла.Возвращает:
индекс текущего цикла
-
currentCountProperty
public ReadOnlyIntegerProperty currentCountProperty()
Количество завершенных циклов воспроизведения. В первом проходе значение должно быть 0. Во втором проходе значение должно быть 1 и так далее. Оно увеличивается в конце каждого цикла непосредственно перед возвратом кstartTime, т.е. когдаstopTimeили конец медиа достигнут.См. также:
-
setMute
public final void setMute(boolean value)
Устанавливает значениеmuteProperty().Параметры:
value- значение настройкиmute
-
isMute
public final boolean isMute()
Возвращает значениеmuteProperty().Возвращает:
значение настройки без звука
-
muteProperty
public BooleanProperty muteProperty()
Указывает, заглушен ли аудиоплеер. Значениеtrueуказывает, что звук не воспроизводится. Значение этого свойства не влияет наvolume, т.е. если звук заглушен, а затем раз заглушен, воспроизведение звука возобновится на том же уровне громкости при условии, что свойствоvolumeне было изменено тем временем. Значение по умолчанию равноfalse.См. также:
-
setOnMarker
public final void setOnMarker(EventHandler<MediaMarkerEvent> onMarker)
Устанавливает обработчик событий маркера.Параметры:
onMarker- обработчик событий маркера.
-
getOnMarker
public final EventHandler<MediaMarkerEvent> getOnMarker()
Возвращает обработчик событий маркера.Возвращает:
обработчик событий маркера.
-
onMarkerProperty
public ObjectProperty<EventHandler<MediaMarkerEvent>> onMarkerProperty()
Обработчик событий, вызываемый, когда плеерcurrentTimeдостигает маркера медиа.См. также:
-
setOnEndOfMedia
public final void setOnEndOfMedia(Runnable value)
Устанавливает обработчик событий конца медиа.Параметры:
value- обработчик событий илиnull.
-
getOnEndOfMedia
public final Runnable getOnEndOfMedia()
Возвращает обработчик событий конца медиа.Возвращает:
обработчик событий или
null.
-
onEndOfMediaProperty
public ObjectProperty<Runnable> onEndOfMediaProperty()
Обработчик событий, вызываемый, когда плеерcurrentTimeдостигаетstopTime.См. также:
-
setOnReady
public final void setOnReady(Runnable value)
Устанавливает обработчик событийMediaPlayer.Status.READY.Параметры:
value- обработчик событий илиnull.
-
getOnReady
public final Runnable getOnReady()
Возвращает обработчик событийMediaPlayer.Status.READY.Возвращает:
обработчик событий или
null.
-
onReadyProperty
public ObjectProperty<Runnable> onReadyProperty()
Обработчик событий, вызываемый, когда состояние меняется наREADY.См. также:
-
setOnPlaying
public final void setOnPlaying(Runnable value)
Устанавливает обработчик событийMediaPlayer.Status.PLAYING.Параметры:
value- обработчик событий илиnull.
-
getOnPlaying
public final Runnable getOnPlaying()
Возвращает обработчик событийMediaPlayer.Status.PLAYING.Возвращает:
обработчик событий или
null.
-
onPlayingProperty
public ObjectProperty<Runnable> onPlayingProperty()
Обработчик событий, вызываемый, когда состояние меняется наPLAYING.См. также:
-
-
setOnPaused
public final void setOnPaused(Runnable value)
Устанавливает обработчик событияMediaPlayer.Status.PAUSED.Параметры:
value- обработчик события илиnull.
-
getOnPaused
public final Runnable getOnPaused()
Возвращает обработчик событияMediaPlayer.Status.PAUSED.Возвращаемое значение:
обработчик события или
null.
-
onPausedProperty
public ObjectProperty<Runnable> onPausedProperty()
Обработчик события, вызываемый при изменении состояния наPAUSED.См. также:
-
setOnStopped
public final void setOnStopped(Runnable value)
Устанавливает обработчик событияMediaPlayer.Status.STOPPED.Параметры:
value- обработчик события илиnull.
-
getOnStopped
public final Runnable getOnStopped()
Возвращает обработчик событияMediaPlayer.Status.STOPPED.Возвращаемое значение:
обработчик события или
null.
-
onStoppedProperty
public ObjectProperty<Runnable> onStoppedProperty()
Обработчик события, вызываемый при изменении состояния наSTOPPED.См. также:
-
setOnHalted
public final void setOnHalted(Runnable value)
Устанавливает обработчик событияMediaPlayer.Status.HALTED.Параметры:
value- обработчик события илиnull.
-
getOnHalted
public final Runnable getOnHalted()
Возвращает обработчик событияMediaPlayer.Status.HALTED.Возвращаемое значение:
обработчик события или
null.
-
onHaltedProperty
public ObjectProperty<Runnable> onHaltedProperty()
Обработчик события, вызываемый при изменении состояния наHALTED.См. также:
-
setOnRepeat
public final void setOnRepeat(Runnable value)
Устанавливает обработчик события повтора.Параметры:
value- обработчик события илиnull.
-
getOnRepeat
public final Runnable getOnRepeat()
Возвращает обработчик события повтора.Возвращаемое значение:
обработчик события или
null.
-
onRepeatProperty
public ObjectProperty<Runnable> onRepeatProperty()
Обработчик события, вызываемый, когда проигрывательcurrentTimeдостигаетstopTimeи будет повторяться. Этот обратный вызов выполняется до возвращения кstartTime.См. также:
-
setOnStalled
public final void setOnStalled(Runnable value)
Устанавливает обработчик событияMediaPlayer.Status.STALLED.Параметры:
value- обработчик события илиnull.
-
getOnStalled
public final Runnable getOnStalled()
Возвращает обработчик событияMediaPlayer.Status.STALLED.Возвращаемое значение:
обработчик события или
null.
-
onStalledProperty
public ObjectProperty<Runnable> onStalledProperty()
Обработчик события, вызываемый при изменении состояния наSTALLED.См. также:
-
setAudioSpectrumNumBands
public final void setAudioSpectrumNumBands(int value)
Устанавливает количество полос в спектре аудиосигнала.Параметры:
value- количество полос спектра;valueдолжно быть ≥ 2
-
getAudioSpectrumNumBands
public final int getAudioSpectrumNumBands()
Возвращает количество полос в спектре аудиосигнала.Возвращаемое значение:
количество полос спектра.
-
audioSpectrumNumBandsProperty
public IntegerProperty audioSpectrumNumBandsProperty()
Количество полос в спектре аудиосигнала. Значение по умолчанию — 128; минимум — 2. Диапазон частот аудиосигнала будет разделен на указанное количество частотных окон. Например, типичный цифровой музыкальный сигнал имеет диапазон частот[0.0, 22050]Гц. Если в этом случае количество полос спектра установить на 10, ширина каждого частотного окна в спектре будет2205Гц, с нижней границей самого низкого частотного окна равной0.0.
-
setAudioSpectrumInterval
public final void setAudioSpectrumInterval(double value)
Устанавливает значение интервала уведомления о спектре аудиосигнала в секундах.Параметры:
value- положительное значение, определяющее интервал обновления спектра
-
getAudioSpectrumInterval
public final double getAudioSpectrumInterval()
Возвращает значение интервала уведомления о спектре аудиосигнала в секундах.Возвращаемое значение:
интервал обновления спектра
-
audioSpectrumIntervalProperty
public DoubleProperty audioSpectrumIntervalProperty()
Интервал между обновлениями спектра в секундах. Значение по умолчанию —0.1секунды.
-
setAudioSpectrumThreshold
public final void setAudioSpectrumThreshold(int value)
Устанавливает порог спектра аудиосигнала в децибелах.Параметры:
value- порог спектра в дБ; должен быть ≤0.
-
getAudioSpectrumThreshold
public final int getAudioSpectrumThreshold()
Возвращает порог спектра аудиосигнала в децибелах.Возвращаемое значение:
порог спектра в дБ
-
audioSpectrumThresholdProperty
public IntegerProperty audioSpectrumThresholdProperty()
Пороговое значение чувствительности в децибелах; должно быть не положительным. Значения ниже этого порога по отношению к пиковой частоте в заданной полосе спектра будут установлены равными значению порога. Значение по умолчанию — -60 дБ.
-
setAudioSpectrumListener
public final void setAudioSpectrumListener(AudioSpectrumListener listener)
Устанавливает слушателя спектра аудиосигнала.Параметры:
listener- слушатель спектра илиnull.
-
getAudioSpectrumListener
public final AudioSpectrumListener getAudioSpectrumListener()
Возвращает слушателя спектра аудиосигнала.Возвращаемое значение:
слушатель спектра или
null
-
audioSpectrumListenerProperty
public ObjectProperty<AudioSpectrumListener> audioSpectrumListenerProperty()
Слушатель для обновлений спектра аудиосигнала. При регистрации слушателя вычисление спектра аудиосигнала включается; при удалении слушателя вычисление отключается. Может быть зарегистрирован только один слушатель, поэтому если требуется несколько наблюдателей, события должны пересылаться.Слушатель, например, может быть полезен для построения частотного спектра воспроизводимого аудио или для генерации волновых форм для визуализатора музыки.
-
dispose
public void dispose()
Освобождает все ресурсы, связанные с проигрывателем. После вызова этой функции проигрыватель НЕ должен использоваться. Проигрыватель перейдет в состояниеStatus.DISPOSEDпосле завершения этого метода. Этот метод можно вызывать в любое время и независимо от текущего состояния проигрывателя.С момента:
JavaFX 8.0
-
© 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.