Класс MediaPlayer

java.lang.Object

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. Это не повлияет на сам плеер. В частности, настройки свойств просмотра не повлияют на воспроизведение медиа.

Since:

JavaFX 2.0

См. также:

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

Modifier and Type	Class	Описание
`static enum`	`MediaPlayer.Status`	Перечисление, описывающее различные значения состояния `MediaPlayer`.

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

Тип	Свойство	Описание
`DoubleProperty`	`audioSpectrumInterval`	Интервал между обновлениями спектра в секундах.
`ObjectProperty<AudioSpectrumListener>`	`audioSpectrumListener`	Обработчик событий для обновлений аудиоспектра.
`IntegerProperty`	`audioSpectrumNumBands`	Количество полос в аудиоспектре.
`IntegerProperty`	`audioSpectrumThreshold`	Пороговое значение чувствительности в децибелах; должно быть не положительным.
`BooleanProperty`	`autoPlay`	Начинать воспроизведение как можно скорее.
`DoubleProperty`	`balance`	Баланс или настройка «лево-право» аудиовывода.
`ReadOnlyObjectProperty<Duration>`	`bufferProgressTime`	Текущая позиция буфера, показывающая, сколько медиа может быть воспроизведено без остановки `MediaPlayer`.
`ReadOnlyIntegerProperty`	`currentCount`	Количество завершенных циклов воспроизведения.
`ReadOnlyDoubleProperty`	`currentRate`	Текущая скорость воспроизведения независимо от настроек.
`ReadOnlyObjectProperty<Duration>`	`currentTime`	Текущее время воспроизведения медиа.
`IntegerProperty`	`cycleCount`	Количество раз, когда медиа будет воспроизведено.
`ReadOnlyObjectProperty<Duration>`	`cycleDuration`	Промежуток времени между `startTime` и `stopTime` этого плеера.
`ReadOnlyObjectProperty<MediaException>`	`error`	Наблюдаемое свойство, устанавливаемое в `MediaException` в случае возникновения ошибки.
`BooleanProperty`	`mute`	Отключен ли аудиоплеер.
`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`.
`DoubleProperty`	`rate`	Скорость воспроизведения медиа.
`ObjectProperty<Duration>`	`startTime`	Смещение времени, в котором медиа должно начать воспроизведение или перезапуск при повторении.
`ReadOnlyObjectProperty<MediaPlayer.Status>`	`status`	Текущее состояние MediaPlayer.
`ObjectProperty<Duration>`	`stopTime`	Смещение времени, в котором медиа должно прекратить воспроизведение или перезапуститься при повторении.
`ReadOnlyObjectProperty<Duration>`	`totalDuration`	Общее время воспроизведения, если разрешено воспроизведение до конца.
`DoubleProperty`	`volume`	Громкость, с которой медиа должно воспроизводиться.

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

Modifier and Type	Поле	Описание
`static final int`	`INDEFINITE`	Значение, представляющее эффективно бесконечное количество циклов воспроизведения.

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

Конструктор	Описание
`MediaPlayer(Media media)`	Создать плеер для определённой медиа.

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

Тип и модификатор	Метод	Описание
`DoubleProperty`	`audioSpectrumIntervalProperty()`	Интервал между обновлениями спектра в секундах.
`ObjectProperty<AudioSpectrumListener>`	`audioSpectrumListenerProperty()`	Listener для обновлений аудио спектра.
`IntegerProperty`	`audioSpectrumNumBandsProperty()`	Количество полос в аудио спектре.
`IntegerProperty`	`audioSpectrumThresholdProperty()`	Пороговое значение чувствительности в децибелах; должно быть неположительным.
`BooleanProperty`	`autoPlayProperty()`	Должно ли воспроизведение начинаться как можно скорее.
`DoubleProperty`	`balanceProperty()`	Баланс или настройка аудиовыхода влево-вправо.
`ReadOnlyObjectProperty<Duration>`	`bufferProgressTimeProperty()`	Текущая позиция буфера, указывающая, какой объем мультимедиа может быть воспроизведен без задержек `MediaPlayer`.
`ReadOnlyIntegerProperty`	`currentCountProperty()`	Количество завершенных циклов воспроизведения.
`ReadOnlyDoubleProperty`	`currentRateProperty()`	Текущая скорость воспроизведения независимо от настроек.
`ReadOnlyObjectProperty<Duration>`	`currentTimeProperty()`	Текущее время воспроизведения медиа.
`IntegerProperty`	`cycleCountProperty()`	Количество раз, которое будет воспроизводиться медиа.
`ReadOnlyObjectProperty<Duration>`	`cycleDurationProperty()`	Количество времени между `startTime` и `stopTime` этого проигрывателя.
`void`	`dispose()`	Освободить все ресурсы, связанные с проигрывателем.
`ReadOnlyObjectProperty<MediaException>`	`errorProperty()`	Наблюдаемое свойство, установленное в `MediaException`, если возникает ошибка.
`final AudioEqualizer`	`getAudioEqualizer()`	Получить `AudioEqualizer`, связанный с этим проигрывателем.
`final double`	`getAudioSpectrumInterval()`	Извлекает значение интервала уведомления о звуковом спектре в секундах.
`final AudioSpectrumListener`	`getAudioSpectrumListener()`	Извлекает прослушиватель звукового спектра.
`final int`	`getAudioSpectrumNumBands()`	Извлекает количество полос в звуковом спектре.
`final int`	`getAudioSpectrumThreshold()`	Извлекает пороговое значение звукового спектра в децибелах.
`final double`	`getBalance()`	Извлекает баланс звука.
`final Duration`	`getBufferProgressTime()`	Извлекает значение `bufferProgressTime`.
`final int`	`getCurrentCount()`	Извлекает индекс текущего цикла.
`final double`	`getCurrentRate()`	Извлекает текущую скорость воспроизведения.
`final Duration`	`getCurrentTime()`	Извлекает текущее время медиа.
`final int`	`getCycleCount()`	Извлекает количество циклов.
`final Duration`	`getCycleDuration()`	Извлекает продолжительность цикла в секундах.
`final MediaException`	`getError()`	Получить значение свойства `error` или `null`, если ошибки нет.
`final Media`	`getMedia()`	Извлекает экземпляр `Media`, который воспроизводится.
`final Runnable`	`getOnEndOfMedia()`	Извлекает обработчик события конца медиа.
`final Runnable`	`getOnError()`	Извлекает обработчик события для ошибок.
`final Runnable`	`getOnHalted()`	Извлекает обработчик события `MediaPlayer.Status.HALTED`.
`final EventHandler<MediaMarkerEvent>`	`getOnMarker()`	Извлекает обработчик события маркера.
`final Runnable`	`getOnPaused()`	Извлекает обработчик события `MediaPlayer.Status.PAUSED`.
`final Runnable`	`getOnPlaying()`	Извлекает обработчик события `MediaPlayer.Status.PLAYING`.
`final Runnable`	`getOnReady()`	Извлекает обработчик события `MediaPlayer.Status.READY`.
`final Runnable`	`getOnRepeat()`	Извлекает обработчик события повтора.
`final Runnable`	`getOnStalled()`	Извлекает обработчик события `MediaPlayer.Status.STALLED`.
`final Runnable`	`getOnStopped()`	Извлекает обработчик события `MediaPlayer.Status.STOPPED`.
`final double`	`getRate()`	Извлекает скорость воспроизведения.
`final Duration`	`getStartTime()`	Извлекает время начала.
`final MediaPlayer.Status`	`getStatus()`	Извлекает текущий статус проигрывателя.
`final Duration`	`getStopTime()`	Извлекает время остановки.
`final Duration`	`getTotalDuration()`	Извлекает общую продолжительность воспроизведения, включая все циклы (повторы).
`final double`	`getVolume()`	Извлекает громкость воспроизведения звука.
`final boolean`	`isAutoPlay()`	Извлекает значение свойства `autoPlay`.
`final boolean`	`isMute()`	Извлекает значение `muteProperty()`.
`BooleanProperty`	`muteProperty()`	Отключен ли звук проигрывателя.
`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`.
`void`	`pause()`	Приостанавливает проигрыватель.
`void`	`play()`	Начинает воспроизведение медиа.
`DoubleProperty`	`rateProperty()`	Скорость, с которой следует воспроизводить медиа.
`void`	`seek(Duration seekTime)`	Перемещает проигрыватель к новому времени воспроизведения.
`final void`	`setAudioSpectrumInterval(double value)`	Устанавливает значение интервала уведомления о звуковом спектре в секундах.
`final void`	`setAudioSpectrumListener(AudioSpectrumListener listener)`	Устанавливает слушателя звукового спектра.

`final void`	`setAudioSpectrumNumBands(int value)`	Устанавливает количество полос в аудиоспектре.
`final void`	`setAudioSpectrumThreshold(int value)`	Устанавливает порог аудиоспектра в децибелах.
`final void`	`setAutoPlay(boolean value)`	Устанавливает значение свойства `autoPlay`.
`final void`	`setBalance(double value)`	Устанавливает баланс аудио.
`final void`	`setCycleCount(int value)`	Устанавливает счётчик циклов.
`final void`	`setMute(boolean value)`	Устанавливает значение `muteProperty()`.
`final void`	`setOnEndOfMedia(Runnable value)`	Устанавливает обработчик события конца медиа.
`final void`	`setOnError(Runnable value)`	Устанавливает обработчик событий, вызываемый при возникновении ошибки.
`final void`	`setOnHalted(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.HALTED`.
`final void`	`setOnMarker(EventHandler<MediaMarkerEvent> onMarker)`	Устанавливает обработчик события маркера.
`final void`	`setOnPaused(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.PAUSED`.
`final void`	`setOnPlaying(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.PLAYING`.
`final void`	`setOnReady(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.READY`.
`final void`	`setOnRepeat(Runnable value)`	Устанавливает обработчик события повтора.
`final void`	`setOnStalled(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.STALLED`.
`final void`	`setOnStopped(Runnable value)`	Устанавливает обработчик события `MediaPlayer.Status.STOPPED`.
`final void`	`setRate(double value)`	Устанавливает скорость воспроизведения указанному значению.
`final void`	`setStartTime(Duration value)`	Устанавливает начальное время.
`final void`	`setStopTime(Duration value)`	Устанавливает конечное время.
`final void`	`setVolume(double value)`	Устанавливает громкость аудиовоспроизведения.
`ObjectProperty<Duration>`	`startTimeProperty()`	Смещение во времени, с которого нужно начать воспроизведение медиа или с которого нужно начать повтор.
`ReadOnlyObjectProperty<MediaPlayer.Status>`	`statusProperty()`	Текущее состояние MediaPlayer.
`void`	`stop()`	Останавливает воспроизведение медиа.
`ObjectProperty<Duration>`	`stopTimeProperty()`	Смещение во времени, до которого нужно воспроизводить медиа или с которого нужно начать повтор.
`ReadOnlyObjectProperty<Duration>`	`totalDurationProperty()`	Общее время воспроизведения, если разрешено воспроизводить до конца.
`DoubleProperty`	`volumeProperty()`	Громкость, с которой нужно воспроизводить медиа.

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

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

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

error

public ReadOnlyObjectProperty<MediaException> errorProperty

Свойство observable, устанавливаемое в 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, то это также будет БЕСКОНЕЧНО. Если продолжительность медиа неизвестна, то и это значение будет НЕИЗВЕСТНО. В противном случае, общее время будет произведением 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. После того, как воспроизводитель перейдет в состояние MediaPlayer.Status.READY, он будет готов к использованию. Время между созданием воспроизводителя и переходом в состояние READY может варьироваться в зависимости, например, от того, загружается ли медиа из сети или локального файловой системы.

Параметры:: media - Медиафайл для воспроизведения.
Исключения:: NullPointerException - если медиафайл null.; MediaException - если произошли какие-либо синхронные ошибки внутри конструктора.

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

END_OF_DOCUMENT_MARKER

getAudioEqualizer

public final AudioEqualizer getAudioEqualizer()

Получить AudioEqualizer, связанный с этим плеером.

Возвращает:: AudioEqualizer или null, если плеер утилизирован.

getError

public final MediaException getError()

Получить значение свойства error или null, если ошибки нет.

Возвращает:: MediaException или null.

errorProperty

public ReadOnlyObjectProperty<MediaException> errorProperty()

Наблюдаемое свойство, устанавливаемое в MediaException, если произошла ошибка.

Возвращает:

свойство error

См. также:

setOnError

public final void setOnError(Runnable value)

Устанавливает обработчик событий, вызываемый при возникновении ошибки.

Параметры:: value - обработчик событий или null.

getOnError

public final Runnable getOnError()

Возвращает обработчик событий для ошибок.

Возвращает:: обработчик событий.

onErrorProperty

public ObjectProperty<Runnable> onErrorProperty()

Обработчик событий, вызываемый при возникновении ошибки.

Возвращает:

свойство onError

См. также:

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.

Возвращает:

свойство autoPlay

См. также:

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.

Возвращает:

свойство rate

См. также:

getCurrentRate

public final double getCurrentRate()

Возвращает текущую скорость воспроизведения.

Возвращает:: текущая скорость

currentRateProperty

public ReadOnlyDoubleProperty currentRateProperty()

Текущая скорость воспроизведения независимо от настроек. Например, если rate установлено в 1,0, а плеер приостановлен или заблокирован, тогда currentRate будет равно нулю.

Возвращает:

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

Возвращает:

свойство volume

См. также:

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.

Возвращает:

свойство balance

См. также:

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

Возвращает:

свойство startTime

См. также:

setStopTime

public final void setStopTime(Duration value)

Устанавливает время остановки. Его влияние будет ограничено диапазоном (startTime, Media.duration]. Вызов этого метода не будет иметь эффекта, если продолжительность медиа Duration.INDEFINITE.

Параметры:: value — время остановки

getStopTime

public final Duration getStopTime()

Возвращает время остановки. Значение по умолчанию — getMedia().getDuration(). Обратите внимание, что Media.duration может иметь значение Duration.UNKNOWN, если инициализация медиа не завершена.

Возвращает:: время остановки

stopTimeProperty

public ObjectProperty<Duration> stopTimeProperty()

Смещение времени, в котором медиа должно остановиться или перезапуститься при повторении. Значение по умолчанию — getMedia().getDuration().

Ограничения: startTime < stopTime ≤ Media.duration

Возвращает:

свойство stopTime

См. также:

getCycleDuration

public final Duration getCycleDuration()

Возвращает продолжительность цикла в секундах.

Возвращает:: продолжительность цикла

cycleDurationProperty

public ReadOnlyObjectProperty<Duration> cycleDurationProperty()

Количество времени между startTime и stopTime этого плеера. Для общей продолжительности медиа используйте свойство Media.duration.

Возвращает:

свойство cycleDuration

См. также:

getTotalDuration

public final Duration getTotalDuration()

Возвращает общее время воспроизведения, включая все циклы (повтор).

Возвращает:: общее время воспроизведения

totalDurationProperty

public ReadOnlyObjectProperty<Duration> totalDurationProperty()

Общее время воспроизведения, если разрешено воспроизводить до конца. Если cycleCount установлено в INDEFINITE, то это также будет INDEFINITE. Если продолжительность медиа UNKNOWN, то это также будет UNKNOWN. В противном случае общее время будет произведением cycleDuration и cycleCount.

Возвращает:

свойство totalDuration

См. также:

getCurrentTime

public final Duration getCurrentTime()

Возвращает текущее время медиа.

Возвращает:: текущее время медиа

currentTimeProperty

public ReadOnlyObjectProperty<Duration> currentTimeProperty()

Текущее время воспроизведения медиа. Это свойство является только для чтения: используйте seek(javafx.util.Duration) для изменения позиции воспроизведения на другую позицию в потоке.

Возвращает:

свойство currentTime

См. также:

seek

public void seek(Duration seekTime)

Перемещает плеер к новому времени воспроизведения. Вызов этого метода не будет иметь эффекта, пока состояние плеера MediaPlayer.Status.STOPPED или продолжительность медиа Duration.INDEFINITE.

Поведение seek() ограничено следующим образом, где начальное время и время остановки указывают эффективные нижнюю и верхнюю границы воспроизведения медиа соответственно:

Таблица поиска MediaPlayer
seekTime	позиция поиска
`null`	без изменений
`Duration.UNKNOWN`	без изменений
`Duration.INDEFINITE`	время остановки
seekTime < время начала	время начала
seekTime > время остановки	время остановки
время начала ≤ seekTime ≤ время остановки	seekTime

Параметры:: seekTime — запрашиваемое время воспроизведения

getStatus

public final MediaPlayer.Status getStatus()

Возвращает текущее состояние плеера.

Возвращает:: состояние воспроизведения

statusProperty

public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty()

Текущее состояние MediaPlayer.

Возвращает:

свойство status

См. также:

getBufferProgressTime

public final Duration getBufferProgressTime()

Возвращает значение bufferProgressTime.

Возвращает:: время прогресса буферизации

bufferProgressTimeProperty

public ReadOnlyObjectProperty<Duration> bufferProgressTimeProperty()

Текущее положение буфера, указывающее, сколько медиа можно воспроизвести без приостановки MediaPlayer. Это применимо к буферизованным потокам, таким как те, которые читаются из сетевых подключений, в отличие, например, от локальных файлов.

Поиск позиции за bufferProgressTime может вызвать небольшую паузу в воспроизведении до тех пор, пока не будет буферизовано достаточное количество данных, чтобы разрешить возобновление воспроизведения.

Возвращает:

свойство 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

Возвращает:

свойство cycleCount

См. также:

getCurrentCount

public final int getCurrentCount()

Возвращает индекс текущего цикла.

Возвращает:: индекс текущего цикла

currentCountProperty

public ReadOnlyIntegerProperty currentCountProperty()

Количество завершённых циклов воспроизведения. В первый проход значение должно быть 0. Во второй проход — 1 и так далее. Увеличивается в конце каждого цикла непосредственно перед возвратом к startTime, т.е. когда stopTime или конец медиа достигнут.

Returns:

свойство currentCount

См. также:

setMute

public final void setMute(boolean value)

Устанавливает значение muteProperty().

Параметры:: value - значение mute

isMute

public final boolean isMute()

Извлекает значение muteProperty().

Returns:: значение настройки mute

muteProperty

public BooleanProperty muteProperty()

Включена ли приостановка звука в плеере. Значение true указывает, что звук не воспроизводится. Значение этого свойства не влияет на volume, т.е., если звук отключен, а затем включен, воспроизведение звука возобновится на том же уровне громкости, при условии, что свойство volume не было изменено тем временем. Значение по умолчанию — false.

Returns:

свойство mute

См. также:

setOnMarker

public final void setOnMarker(EventHandler<MediaMarkerEvent> onMarker)

Устанавливает обработчик событий маркера.

Параметры:: onMarker - обработчик событий маркера.

getOnMarker

public final EventHandler<MediaMarkerEvent> getOnMarker()

Возвращает обработчик событий маркера.

Returns:: обработчик событий маркера.

onMarkerProperty

public ObjectProperty<EventHandler<MediaMarkerEvent>> onMarkerProperty()

Обработчик событий, вызываемый, когда плеер currentTime достигает маркера медиа.

Returns:

свойство onMarker

См. также:

setOnEndOfMedia

public final void setOnEndOfMedia(Runnable value)

Устанавливает обработчик событий конца медиа.

Параметры:: value - обработчик событий или null.

getOnEndOfMedia

public final Runnable getOnEndOfMedia()

Возвращает обработчик событий конца медиа.

Returns:: обработчик событий или null.

onEndOfMediaProperty

public ObjectProperty<Runnable> onEndOfMediaProperty()

Обработчик событий, вызываемый, когда плеер currentTime достигает stopTime.

Returns:

свойство onEndOfMedia

См. также:

setOnReady

public final void setOnReady(Runnable value)

Устанавливает обработчик события MediaPlayer.Status.READY.

Параметры:: value - обработчик событий или null.

getOnReady

public final Runnable getOnReady()

Возвращает обработчик события MediaPlayer.Status.READY.

Returns:: обработчик событий или null.

onReadyProperty

public ObjectProperty<Runnable> onReadyProperty()

Обработчик событий, вызываемый, когда состояние изменяется на READY.

Returns:

свойство onReady

См. также:

setOnPlaying

public final void setOnPlaying(Runnable value)

Устанавливает обработчик события MediaPlayer.Status.PLAYING.

Параметры:: value - обработчик событий или null.

getOnPlaying

public final Runnable getOnPlaying()

Возвращает обработчик события MediaPlayer.Status.PLAYING.

Returns:: обработчик событий или null.

onPlayingProperty

public ObjectProperty<Runnable> onPlayingProperty()

Обработчик событий, вызываемый, когда состояние изменяется на PLAYING.

Returns:

свойство onPlaying

См. также:

setOnPaused

public final void setOnPaused(Runnable value)

Устанавливает обработчик события MediaPlayer.Status.PAUSED.

Параметры:: value - обработчик событий или null.

getOnPaused

public final Runnable getOnPaused()

Возвращает обработчик события MediaPlayer.Status.PAUSED.

Returns:: обработчик событий или null.

onPausedProperty

public ObjectProperty<Runnable> onPausedProperty()

Обработчик событий, вызываемый, когда состояние изменяется на PAUSED.

Returns:

свойство onPaused

См. также:

setOnStopped

public final void setOnStopped(Runnable value)

Устанавливает обработчик события MediaPlayer.Status.STOPPED.

Параметры:: value - обработчик событий или null.

getOnStopped

public final Runnable getOnStopped()

Возвращает обработчик события MediaPlayer.Status.STOPPED.

Returns:: обработчик событий или null.

onStoppedProperty

public ObjectProperty<Runnable> onStoppedProperty()

Обработчик событий, вызываемый, когда состояние изменяется на STOPPED.

Returns:

свойство onStopped

См. также:

setOnHalted

public final void setOnHalted(Runnable value)

Устанавливает обработчик события MediaPlayer.Status.HALTED.

Параметры:: value - обработчик событий или null.

getOnHalted

public final Runnable getOnHalted()

Возвращает обработчик события MediaPlayer.Status.HALTED.

Returns:: обработчик событий или null.

onHaltedProperty

public ObjectProperty<Runnable> onHaltedProperty()

Обработчик событий, вызываемый, когда состояние изменяется на HALTED.

Returns:

свойство onHalted

См. также:

setOnRepeat

public final void setOnRepeat(Runnable value)

Устанавливает обработчик события повтора.

Параметры:: value - обработчик событий или null.

END_OF_DOCUMENT_MARKER

getOnRepeat

public final Runnable getOnRepeat()

Возвращает обработчик события повтора.

Возвращает:: обработчик событий или null.

onRepeatProperty

public ObjectProperty<Runnable> onRepeatProperty()

Обработчик событий, вызываемый, когда проигрыватель currentTime достигает stopTime и будет повторяться. Этот обратный вызов выполняется перед возвращением к startTime.

Возвращает:

свойство onRepeat

См. также:

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.

Возвращает:

свойство onStalled

См. также:

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.

Возвращает:

свойство audioSpectrumNumBands

См. также:

setAudioSpectrumInterval

public final void setAudioSpectrumInterval(double value)

Устанавливает значение интервала уведомлений спектра аудиосигнала в секундах.

Параметры:: value - положительное значение, определяющее интервал обновления спектра

getAudioSpectrumInterval

public final double getAudioSpectrumInterval()

Возвращает значение интервала уведомлений спектра аудиосигнала в секундах.

Возвращает:: интервал обновления спектра

audioSpectrumIntervalProperty

public DoubleProperty audioSpectrumIntervalProperty()

Интервал между обновлениями спектра в секундах. По умолчанию — 0.1 секунды.

Возвращает:

свойство audioSpectrumInterval

См. также:

setAudioSpectrumThreshold

public final void setAudioSpectrumThreshold(int value)

Устанавливает порог спектра аудиосигнала в децибелах.

Параметры:: value - порог спектра в дБ; должен быть ≤ 0.

getAudioSpectrumThreshold

public final int getAudioSpectrumThreshold()

Возвращает порог спектра аудиосигнала в децибелах.

Возвращает:: порог спектра в дБ

audioSpectrumThresholdProperty

public IntegerProperty audioSpectrumThresholdProperty()

Порог чувствительности в децибелах; должен быть не положительным. Значения ниже этого порога относительно пиковой частоты в заданной спектральной полосе будут установлены в значение порога. Значение по умолчанию — -60 дБ.

Возвращает:

свойство audioSpectrumThreshold

См. также:

setAudioSpectrumListener

public final void setAudioSpectrumListener(AudioSpectrumListener listener)

Устанавливает слушателя спектра аудиосигнала.

Параметры:: listener - слушатель спектра или null.

getAudioSpectrumListener

public final AudioSpectrumListener getAudioSpectrumListener()

Возвращает слушателя спектра аудиосигнала.

Возвращает:: слушатель спектра или null

audioSpectrumListenerProperty

public ObjectProperty<AudioSpectrumListener> audioSpectrumListenerProperty()

Слушатель обновлений спектра аудиосигнала. При регистрации слушателя вычисление спектра аудиосигнала включается; при удалении слушателя — выключается. Может быть зарегистрирован только один слушатель; если требуется несколько наблюдателей, события должны быть перенаправлены.

Слушатель может быть полезен, например, для построения частотного спектра воспроизводимого аудио или для генерации волновых форм для визуализатора музыки.

Возвращает:

свойство audioSpectrumListener

См. также:

dispose

public void dispose()

Освобождает все ресурсы, связанные с проигрывателем. После вызова этой функции проигрыватель БОЛЬШЕ НЕ ДОЛЖЕН использоваться. После выполнения этого метода проигрыватель перейдет в состояние MediaPlayer.Status.DISPOSED. Этот метод можно вызвать в любое время независимо от текущего состояния проигрывателя.

Since:: 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.