Класс MediaPlayer

java.lang.Object

fx.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

См. также:

END_OF_DOCUMENT_MARKER

Сводка свойств

Тип	Свойство	Описание
`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`	Громкость, с которой должно воспроизводиться медиа.

Сводка вложенных классов

Модификатор и тип	Класс	Описание
`static enum`	`MediaPlayer.Status`	Перечисление, описывающее различные значения статуса `MediaPlayer`.

Сводка полей

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

Сводка конструкторов

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

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

Тип и модификатор	Метод	Описание
`DoubleProperty`	`audioSpectrumIntervalProperty()`	Интервал между обновлениями спектра в секундах.
`ObjectProperty<AudioSpectrumListener>`	`audioSpectrumListenerProperty()`	Слушатель для обновлений аудиоспектра.
`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

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

ошибка

public ReadOnlyObjectProperty<MediaException> errorProperty

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

См. также:

getError()
errorProperty()

onError

public ObjectProperty<Runnable> onErrorProperty

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

См. также:

getOnError()
setOnError(Runnable)
onErrorProperty()

autoPlay

public BooleanProperty autoPlayProperty

Указывает, должно ли воспроизведение начинаться как можно скорее. Для нового плеера это произойдет после того, как плеер достигнет состояния READY. Значение по умолчанию — false.

См. также:

isAutoPlay()
setAutoPlay(boolean)
autoPlayProperty()

скорость

public DoubleProperty rateProperty

Скорость воспроизведения медиа. Например, скорость 1.0 воспроизводит медиа с обычной (закодированной) скоростью воспроизведения, 2.0 воспроизводит в два раза быстрее, и т. д. В настоящее время поддерживается диапазон скоростей [0.0, 8.0]. Значение по умолчанию — 1.0.

См. также:

getRate()
setRate(double)
rateProperty()

текущая скорость

public ReadOnlyDoubleProperty currentRateProperty

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

См. также:

getCurrentRate()
currentRateProperty()

громкость

public DoubleProperty volumeProperty

Громкость, с которой следует воспроизводить медиа. Диапазон эффективных значений — [0.0 1.0], где 0.0 — не слышно, а 1.0 — максимальная громкость, которая является значением по умолчанию.

См. также:

getVolume()
setVolume(double)
volumeProperty()

баланс

public DoubleProperty balanceProperty

Баланс или стереобаланс аудиовывода. Диапазон эффективных значений — [-1.0, 1.0], где -1.0 — полностью слева, 0.0 — по центру, а 1.0 — полностью справа. Значение по умолчанию — 0.0.

См. также:

getBalance()
setBalance(double)
balanceProperty()

начальное время

public ObjectProperty<Duration> startTimeProperty

Смещение времени, с которого должно начаться воспроизведение медиа или с которого должно начаться повтор. При остановке воспроизведения текущее время сбрасывается до этого значения. Если это значение положительное, то при первом воспроизведении медиа может быть задержка перед началом воспроизведения, если позиция воспроизведения может быть установлена в произвольное время в пределах медиа. Это может произойти, например, для видео, которое не содержит таблицы поиска смещений кадров I в потоке видео. В таком случае кадры видео необходимо пропускать, пока не будет достигнута позиция первого кадра I перед начальным временем. Значение по умолчанию — Duration.ZERO.

Ограничения: 0 ≤ startTime < stopTime

См. также:

getStartTime()
setStartTime(Duration)
startTimeProperty()

конечное время

public ObjectProperty<Duration> stopTimeProperty

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

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

См. также:

getStopTime()
setStopTime(Duration)
stopTimeProperty()

длительность цикла

public ReadOnlyObjectProperty<Duration> cycleDurationProperty

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

См. также:

getCycleDuration()
cycleDurationProperty()

общая длительность

public ReadOnlyObjectProperty<Duration> totalDurationProperty

Общее время воспроизведения, если разрешено воспроизводить до конца. Если cycleCount установлено в INDEFINITE, то это также будет БЕСКОНЕЧНО. Если длительность медиа НЕИЗВЕСТНА, то это также будет НЕИЗВЕСТНО. В противном случае общая продолжительность будет произведением cycleDuration и cycleCount.

См. также:

getTotalDuration()
totalDurationProperty()

текущее время

public ReadOnlyObjectProperty<Duration> currentTimeProperty

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

См. также:

getCurrentTime()
currentTimeProperty()

состояние

public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty

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

См. также:

getStatus()
statusProperty()

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

public ReadOnlyObjectProperty<Duration> bufferProgressTimeProperty

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

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

См. также:

getBufferProgressTime()
bufferProgressTimeProperty()

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

public IntegerProperty cycleCountProperty

Количество раз, которое медиа будет воспроизводиться. По умолчанию cycleCount установлено в 1, что означает, что медиа будет воспроизведено только один раз. Установка cycleCount на значение больше 1 приведет к воспроизведению медиа заданное количество раз или до остановки. Если установлено INDEFINITE, воспроизведение будет повторяться до вызова stop() или pause().

ограничения: cycleCount ≥ 1

См. также:

getCycleCount()
setCycleCount(int)
cycleCountProperty()

текущий счетчик

public ReadOnlyIntegerProperty currentCountProperty

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

См. также:

getCurrentCount()
currentCountProperty()

немая

public BooleanProperty muteProperty

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

См. также:

isMute()
setMute(boolean)
muteProperty()

Обработчик события onMarker

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

См. также: