MediaPlayer

java.lang.Object
- javafx.scene.media.MediaPlayer

```
public final class MediaPlayer
extends java.lang.Object
```
The MediaPlayer class provides the controls for playing media. It is used in combination with the Media and MediaView classes to display and control media playback. MediaPlayer does not contain any visual elements so must be used with the MediaView class to view any video track which may be present.
MediaPlayer provides the pause(), play(), stop() and seek() controls as well as the rate and autoPlay properties which apply to all types of media. It also provides the balance, mute, and volume properties which control audio playback characteristics. Further control over audio quality may be attained via the AudioEqualizer associated with the player. Frequency descriptors of audio playback may be observed by registering an AudioSpectrumListener. Information about playback position, rate, and buffering may be obtained from the currentTime, currentRate, and bufferProgressTime properties, respectively. Media marker notifications are received by an event handler registered as the onMarker property.

For finite duration media, playback may be positioned at any point in time between 0.0 and the duration of the media. MediaPlayer refines this definition by adding the startTime and stopTime properties which in effect define a virtual media source with time position constrained to [startTime,stopTime]. Media playback commences at startTime and continues to stopTime. The interval defined by these two endpoints is termed a cycle with duration being the difference of the stop and start times. This cycle may be set to repeat a specific or indefinite number of times. The total duration of media playback is then the product of the cycle duration and the number of times the cycle is played. If the stop time of the cycle is reached and the cycle is to be played again, the event handler registered with the onRepeat property is invoked. If the stop time is reached and the cycle is not to be repeated, then the event handler registered with the onEndOfMedia property is invoked. A zero-relative index of which cycle is presently being played is maintained by currentCount.

The operation of a MediaPlayer is inherently asynchronous. A player is not prepared to respond to commands quasi-immediately until its status has transitioned to MediaPlayer.Status.READY, which in effect generally occurs when media pre-roll completes. Some requests made of a player prior to its status being READY will however take effect when that status is entered. These include invoking play() without an intervening invocation of pause() or stop() before the READY transition, as well as setting any of the autoPlay, balance, mute, rate, startTime, stopTime, and volume properties.

The status property may be monitored to make the application aware of player status changes, and callback functions may be registered via properties such as onReady if an action should be taken when a particular status is entered. There are also error and onError properties which respectively enable monitoring when an error occurs and taking a specified action in response thereto.

The same MediaPlayer object may be shared among multiple MediaViews. This will not affect the player itself. In particular, the property settings of the view will not have any effect on media playback.

Since:

JavaFX 2.0

See Also:

Media, MediaView

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`DoubleProperty`	`audioSpectrumInterval` The interval between spectrum updates in seconds.
`<any>`	`audioSpectrumListener` A listener for audio spectrum updates.
`IntegerProperty`	`audioSpectrumNumBands` The number of bands in the audio spectrum.
`IntegerProperty`	`audioSpectrumThreshold` The sensitivity threshold in decibels; must be non-positive.
`BooleanProperty`	`autoPlay` Whether playing should start as soon as possible.
`DoubleProperty`	`balance` The balance, or left-right setting, of the audio output.
`<any>`	`bufferProgressTime` The current buffer position indicating how much media can be played without stalling the `MediaPlayer`.
`ReadOnlyIntegerProperty`	`currentCount` The number of completed playback cycles.
`ReadOnlyDoubleProperty`	`currentRate` The current rate of playback regardless of settings.
`<any>`	`currentTime` The current media playback time.
`IntegerProperty`	`cycleCount` The number of times the media will be played.
`<any>`	`cycleDuration` The amount of time between the `startTime` and `stopTime` of this player.
`<any>`	`error` Observable property set to a `MediaException` if an error occurs.
`BooleanProperty`	`mute` Whether the player audio is muted.
`<any>`	`onEndOfMedia` Event handler invoked when the player `currentTime` reaches `stopTime`.
`<any>`	`onError` Event handler invoked when an error occurs.
`<any>`	`onHalted` Event handler invoked when the status changes to `HALTED`.
`<any>`	`onMarker` Event handler invoked when the player `currentTime` reaches a media marker.
`<any>`	`onPaused` Event handler invoked when the status changes to `PAUSED`.
`<any>`	`onPlaying` Event handler invoked when the status changes to `PLAYING`.
`<any>`	`onReady` Event handler invoked when the status changes to `READY`.
`<any>`	`onRepeat` Event handler invoked when the player `currentTime` reaches `stopTime` and will be repeating.
`<any>`	`onStalled` Event handler invoked when the status changes to `STALLED`.
`<any>`	`onStopped` Event handler invoked when the status changes to `STOPPED`.
`DoubleProperty`	`rate` The rate at which the media should be played.
`<any>`	`startTime` The time offset where media should start playing, or restart from when repeating.
`<any>`	`status` The current state of the MediaPlayer.
`<any>`	`stopTime` The time offset where media should stop playing or restart when repeating.
`<any>`	`totalDuration` The total amount of play time if allowed to play until finished.
`DoubleProperty`	`volume` The volume at which the media should be played.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`MediaPlayer._BufferListener`
`private class`	`MediaPlayer._MarkerListener` Listener of marker events emitted by the implementation layer.
`private class`	`MediaPlayer._MediaErrorListener`
`private class`	`MediaPlayer._PlayerStateListener`
`private class`	`MediaPlayer._PlayerTimeListener`
`private class`	`MediaPlayer._SpectrumListener`
`private class`	`MediaPlayer._VideoTrackSizeListener`
`private class`	`MediaPlayer.InitMediaPlayer`
`private class`	`MediaPlayer.MarkerMapChangeListener` Listeners section Listener of modifications to the marker map in the public Media API.
`private class`	`MediaPlayer.RendererListener`
`static class`	`MediaPlayer.Status` Enumeration describing the different status values of a `MediaPlayer`.

Field Summary

Fields
Modifier and Type	Field and Description
`private AudioEqualizer`	`audioEqualizer` The read-only `AudioEqualizer` associated with this player.
`private static double`	`AUDIOSPECTRUM_INTERVAL_MIN`
`private static int`	`AUDIOSPECTRUM_NUMBANDS_MIN`
`private static int`	`AUDIOSPECTRUM_THRESHOLD_MAX`
`private boolean`	`audioSpectrumEnabledChangeRequested`
`private DoubleProperty`	`audioSpectrumInterval` The interval between spectrum updates in seconds.
`private boolean`	`audioSpectrumIntervalChangeRequested`
`private <any>`	`audioSpectrumListener` A listener for audio spectrum updates.
`private IntegerProperty`	`audioSpectrumNumBands` The number of bands in the audio spectrum.
`private boolean`	`audioSpectrumNumBandsChangeRequested`
`private IntegerProperty`	`audioSpectrumThreshold` The sensitivity threshold in decibels; must be non-positive.
`private boolean`	`audioSpectrumThresholdChangeRequested`
`private BooleanProperty`	`autoPlay` Whether playing should start as soon as possible.
`private DoubleProperty`	`balance` The balance, or left-right setting, of the audio output.
`private boolean`	`balanceChangeRequested`
`private BufferListener`	`bufferListener`
`private <any>`	`bufferProgressTime` The current buffer position indicating how much media can be played without stalling the `MediaPlayer`.
`private ReadOnlyIntegerWrapper`	`currentCount` The number of completed playback cycles.
`private ReadOnlyDoubleWrapper`	`currentRate` The current rate of playback regardless of settings.
`private VideoDataBuffer`	`currentRenderFrame`
`private <any>`	`currentTime` The current media playback time.
`private IntegerProperty`	`cycleCount` The number of times the media will be played.
`private <any>`	`cycleDuration` The amount of time between the `startTime` and `stopTime` of this player.
`private static int`	`DEFAULT_SPECTRUM_BAND_COUNT`
`private static double`	`DEFAULT_SPECTRUM_INTERVAL`
`private static int`	`DEFAULT_SPECTRUM_THRESHOLD`
`private java.lang.Object`	`disposeLock`
`private <any>`	`error` Observable property set to a `MediaException` if an error occurs.
`private com.sun.media.jfxmedia.events.MediaErrorListener`	`errorListener`
`static int`	`INDEFINITE` A value representing an effectively infinite number of playback cycles.
`private boolean`	`isEOS`
`private boolean`	`isUpdateTimeEnabled`
`private com.sun.media.jfxmedia.MediaPlayer`	`jfxPlayer`
`private BufferProgressEvent`	`lastBufferEvent`
`private MarkerListener`	`markerEventListener`
`private <any>`	`markerMapListener`
`private Media`	`media` The parent `Media` object; read-only.
`private MediaTimerTask`	`mediaTimerTask`
`private BooleanProperty`	`mute` Whether the player audio is muted.
`private boolean`	`muteChangeRequested`
`private VideoDataBuffer`	`nextRenderFrame`
`private <any>`	`onEndOfMedia` Event handler invoked when the player `currentTime` reaches `stopTime`.
`private <any>`	`onError` Event handler invoked when an error occurs.
`private <any>`	`onHalted` Event handler invoked when the status changes to `HALTED`.
`private <any>`	`onMarker` Event handler invoked when the player `currentTime` reaches a media marker.
`private <any>`	`onPaused` Event handler invoked when the status changes to `PAUSED`.
`private <any>`	`onPlaying` Event handler invoked when the status changes to `PLAYING`.
`private <any>`	`onReady` Event handler invoked when the status changes to `READY`.
`private <any>`	`onRepeat` Event handler invoked when the player `currentTime` reaches `stopTime` and will be repeating.
`private <any>`	`onStalled` Event handler invoked when the status changes to `STALLED`.
`private <any>`	`onStopped` Event handler invoked when the status changes to `STOPPED`.
`private boolean`	`playerReady`
`private boolean`	`playRequested`
`private double`	`prevTimeMs`
`private DoubleProperty`	`rate` The rate at which the media should be played.
`private static double`	`RATE_MAX`
`private static double`	`RATE_MIN`
`private boolean`	`rateChangeRequested`
`private MediaPlayer.RendererListener`	`rendererListener`
`private java.lang.Object`	`renderLock`
`private VideoTrackSizeListener`	`sizeListener`
`private com.sun.media.jfxmedia.events.AudioSpectrumListener`	`spectrumListener`
`private <any>`	`startTime` The time offset where media should start playing, or restart from when repeating.
`private Duration`	`startTimeAtStop`
`private boolean`	`startTimeChangeRequested`
`private PlayerStateListener`	`stateListener`
`private <any>`	`status` The current state of the MediaPlayer.
`private <any>`	`stopTime` The time offset where media should stop playing or restart when repeating.
`private boolean`	`stopTimeChangeRequested`
`private PlayerTimeListener`	`timeListener`
`private <any>`	`totalDuration` The total amount of play time if allowed to play until finished.
`private java.util.Set<java.lang.ref.WeakReference<MediaView>>`	`viewRefs`
`private DoubleProperty`	`volume` The volume at which the media should be played.
`private boolean`	`volumeChangeRequested`

Constructor Summary

Constructors
Constructor and Description

MediaPlayer(Media media)
Create a player for a specific media.

Constructors
Constructor and Description
`MediaPlayer(Media media)` Create a player for a specific media.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`addView(MediaView view)`
`DoubleProperty`	`audioSpectrumIntervalProperty()` The interval between spectrum updates in seconds.
`<any>`	`audioSpectrumListenerProperty()` A listener for audio spectrum updates.
`IntegerProperty`	`audioSpectrumNumBandsProperty()` The number of bands in the audio spectrum.
`IntegerProperty`	`audioSpectrumThresholdProperty()` The sensitivity threshold in decibels; must be non-positive.
`BooleanProperty`	`autoPlayProperty()` Whether playing should start as soon as possible.
`DoubleProperty`	`balanceProperty()` The balance, or left-right setting, of the audio output.
`<any>`	`bufferProgressTimeProperty()` The current buffer position indicating how much media can be played without stalling the `MediaPlayer`.
`private <any>`	`bufferProgressTimePropertyImpl()`
`private void`	`calculateCycleDuration()`
`private double[]`	`calculateStartStopTimes(Duration startValue, Duration stopValue)` Behaviorally clamp the start and stop times.
`private void`	`calculateTotalDuration()`
`private static double`	`clamp(double dvalue, double dmin, double dmax)`
`private static int`	`clamp(int ivalue, int imin, int imax)`
`(package private) void`	`createMediaTimer()`
`ReadOnlyIntegerProperty`	`currentCountProperty()` The number of completed playback cycles.
`private ReadOnlyIntegerWrapper`	`currentCountPropertyImpl()`
`ReadOnlyDoubleProperty`	`currentRateProperty()` The current rate of playback regardless of settings.
`private ReadOnlyDoubleWrapper`	`currentRatePropertyImpl()`
`<any>`	`currentTimeProperty()` The current media playback time.
`private <any>`	`currentTimePropertyImpl()`
`IntegerProperty`	`cycleCountProperty()` The number of times the media will be played.
`<any>`	`cycleDurationProperty()` The amount of time between the `startTime` and `stopTime` of this player.
`private <any>`	`cycleDurationPropertyImpl()`
`(package private) void`	`destroyMediaTimer()`
`void`	`dispose()` Free all resources associated with player.
`<any>`	`errorProperty()` Observable property set to a `MediaException` if an error occurs.
`private <any>`	`errorPropertyImpl()`
`AudioEqualizer`	`getAudioEqualizer()` Retrieve the `AudioEqualizer` associated with this player.
`double`	`getAudioSpectrumInterval()` Retrieves the value of the audio spectrum notification interval in seconds.
`AudioSpectrumListener`	`getAudioSpectrumListener()` Retrieves the listener of the audio spectrum.
`int`	`getAudioSpectrumNumBands()` Retrieves the number of bands in the audio spectrum.
`int`	`getAudioSpectrumThreshold()` Retrieves the audio spectrum threshold in decibels.
`double`	`getBalance()` Retrieves the audio balance.
`Duration`	`getBufferProgressTime()` Retrieves the `bufferProgressTime` value.
`int`	`getCurrentCount()` Retrieves the index of the current cycle.
`double`	`getCurrentRate()` Retrieves the current playback rate.
`Duration`	`getCurrentTime()` Retrieves the current media time.
`int`	`getCycleCount()` Retrieves the cycle count.
`Duration`	`getCycleDuration()` Retrieves the cycle duration in seconds.
`MediaException`	`getError()` Retrieve the value of the `error` property or `null` if there is no error.
`(package private) VideoDataBuffer`	`getLatestFrame()` WARNING: You must call releaseFrame() on the returned frame when you are finished with it or a massive memory leak will occur.
`Media`	`getMedia()` Retrieves the `Media` instance being played.
`java.lang.Runnable`	`getOnEndOfMedia()` Retrieves the end of media event handler.
`java.lang.Runnable`	`getOnError()` Retrieves the event handler for errors.
`java.lang.Runnable`	`getOnHalted()` Retrieves the `MediaPlayer.Status.HALTED` event handler.
`<any>`	`getOnMarker()` Retrieves the marker event handler.
`java.lang.Runnable`	`getOnPaused()` Retrieves the `MediaPlayer.Status.PAUSED` event handler.
`java.lang.Runnable`	`getOnPlaying()` Retrieves the `MediaPlayer.Status.PLAYING` event handler.
`java.lang.Runnable`	`getOnReady()` Retrieves the `MediaPlayer.Status.READY` event handler.
`java.lang.Runnable`	`getOnRepeat()` Retrieves the repeat event handler.
`java.lang.Runnable`	`getOnStalled()` Retrieves the `MediaPlayer.Status.STALLED` event handler.
`java.lang.Runnable`	`getOnStopped()` Retrieves the `MediaPlayer.Status.STOPPED` event handler.
`double`	`getRate()` Retrieves the playback rate.
`Duration`	`getStartTime()` Retrieves the start time.
`MediaPlayer.Status`	`getStatus()` Retrieves the current player status.
`Duration`	`getStopTime()` Retrieves the stop time.
`Duration`	`getTotalDuration()` Retrieves the total playback duration including all cycles (repetitions).
`double`	`getVolume()` Retrieves the audio playback volume.
`(package private) void`	`handleError(MediaException error)`
`(package private) void`	`handleRequestedChanges()`
`private void`	`init()`
`boolean`	`isAutoPlay()` Retrieves the `autoPlay` property value.
`boolean`	`isMute()` Retrieves the `muteProperty()` value.
`(package private) void`	`loopPlayback()`
`BooleanProperty`	`muteProperty()` Whether the player audio is muted.
`<any>`	`onEndOfMediaProperty()` Event handler invoked when the player `currentTime` reaches `stopTime`.
`<any>`	`onErrorProperty()` Event handler invoked when an error occurs.
`<any>`	`onHaltedProperty()` Event handler invoked when the status changes to `HALTED`.
`<any>`	`onMarkerProperty()` Event handler invoked when the player `currentTime` reaches a media marker.
`<any>`	`onPausedProperty()` Event handler invoked when the status changes to `PAUSED`.
`<any>`	`onPlayingProperty()` Event handler invoked when the status changes to `PLAYING`.
`<any>`	`onReadyProperty()` Event handler invoked when the status changes to `READY`.
`<any>`	`onRepeatProperty()` Event handler invoked when the player `currentTime` reaches `stopTime` and will be repeating.
`<any>`	`onStalledProperty()` Event handler invoked when the status changes to `STALLED`.
`<any>`	`onStoppedProperty()` Event handler invoked when the status changes to `STOPPED`.
`void`	`pause()` Pauses the player.
`void`	`play()` Starts playing the media.
`(package private) void`	`preReady()`
`DoubleProperty`	`rateProperty()` The rate at which the media should be played.
`(package private) void`	`registerListeners()`
`(package private) void`	`removeView(MediaView view)`
`(package private) com.sun.media.jfxmedia.MediaPlayer`	`retrieveJfxPlayer()`
`void`	`seek(Duration seekTime)` Seeks the player to a new playback time.
`void`	`setAudioSpectrumInterval(double value)` Sets the value of the audio spectrum notification interval in seconds.
`void`	`setAudioSpectrumListener(AudioSpectrumListener listener)` Sets the listener of the audio spectrum.
`void`	`setAudioSpectrumNumBands(int value)` Sets the number of bands in the audio spectrum.
`void`	`setAudioSpectrumThreshold(int value)` Sets the audio spectrum threshold in decibels.
`void`	`setAutoPlay(boolean value)` Sets the `autoPlay` property value.
`void`	`setBalance(double value)` Sets the audio balance.
`private void`	`setBufferProgressTime(Duration value)`
`private void`	`setCurrentCount(int value)`
`private void`	`setCurrentRate(double value)`
`private void`	`setCurrentTime(Duration value)`
`void`	`setCycleCount(int value)` Sets the cycle count.
`private void`	`setCycleDuration(Duration value)`
`private void`	`setError(MediaException value)`
`void`	`setMute(boolean value)` Sets the value of `muteProperty()`.
`void`	`setOnEndOfMedia(java.lang.Runnable value)` Sets the end of media event handler.
`void`	`setOnError(java.lang.Runnable value)` Sets the event handler to be called when an error occurs.
`void`	`setOnHalted(java.lang.Runnable value)` Sets the `MediaPlayer.Status.HALTED` event handler.
`void`	`setOnMarker(<any> onMarker)` Sets the marker event handler.
`void`	`setOnPaused(java.lang.Runnable value)` Sets the `MediaPlayer.Status.PAUSED` event handler.
`void`	`setOnPlaying(java.lang.Runnable value)` Sets the `MediaPlayer.Status.PLAYING` event handler.
`void`	`setOnReady(java.lang.Runnable value)` Sets the `MediaPlayer.Status.READY` event handler.
`void`	`setOnRepeat(java.lang.Runnable value)` Sets the repeat event handler.
`void`	`setOnStalled(java.lang.Runnable value)` Sets the `MediaPlayer.Status.STALLED` event handler.
`void`	`setOnStopped(java.lang.Runnable value)` Sets the `MediaPlayer.Status.STOPPED` event handler.
`void`	`setRate(double value)` Sets the playback rate to the supplied value.
`private void`	`setStartStopTimes(Duration startValue, boolean isStartValueSet, Duration stopValue, boolean isStopValueSet)` Set the effective start and stop times on the underlying player, clamping as needed.
`void`	`setStartTime(Duration value)` Sets the start time.
`private void`	`setStatus(MediaPlayer.Status value)`
`void`	`setStopTime(Duration value)` Sets the stop time.
`private void`	`setTotalDuration(Duration value)`
`void`	`setVolume(double value)` Sets the audio playback volume.
`<any>`	`startTimeProperty()` The time offset where media should start playing, or restart from when repeating.
`<any>`	`statusProperty()` The current state of the MediaPlayer.
`private <any>`	`statusPropertyImpl()`
`void`	`stop()` Stops playing the media.
`<any>`	`stopTimeProperty()` The time offset where media should stop playing or restart when repeating.
`<any>`	`totalDurationProperty()` The total amount of play time if allowed to play until finished.
`private <any>`	`totalDurationPropertyImpl()`
`(package private) void`	`updateTime()`
`DoubleProperty`	`volumeProperty()` The volume at which the media should be played.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail
- error
```
public <any> errorProperty
```
  Observable property set to a MediaException if an error occurs.
  
  See Also:
  
  getError()
- onError
```
public <any> onErrorProperty
```
  Event handler invoked when an error occurs.
  
  See Also:
  
  getOnError(), setOnError(Runnable)
- autoPlay
```
public BooleanProperty autoPlayProperty
```
  Whether playing should start as soon as possible. For a new player this will occur once the player has reached the READY state. The default value is false.
  
  See Also:
  
  isAutoPlay(), setAutoPlay(boolean)
- rate
```
public DoubleProperty rateProperty
```
  The rate at which the media should be played. For example, a rate of 1.0 plays the media at its normal (encoded) playback rate, 2.0 plays back at twice the normal rate, etc. The currently supported range of rates is [0.0, 8.0]. The default value is 1.0.
  
  See Also:
  
  getRate(), setRate(double)
- currentRate
```
public ReadOnlyDoubleProperty currentRateProperty
```
  The current rate of playback regardless of settings. For example, if rate is set to 1.0 and the player is paused or stalled, then currentRate will be zero.
  
  See Also:
  
  getCurrentRate()
- volume
```
public DoubleProperty volumeProperty
```
  The volume at which the media should be played. The range of effective values is [0.0 1.0] where 0.0 is inaudible and 1.0 is full volume, which is the default.
  
  See Also:
  
  getVolume(), setVolume(double)
- balance
```
public DoubleProperty balanceProperty
```
  The balance, or left-right setting, of the audio output. The range of effective values is [-1.0, 1.0] with -1.0 being full left, 0.0 center, and 1.0 full right. The default value is 0.0.
  
  See Also:
  
  getBalance(), setBalance(double)
- startTime
```
public <any> startTimeProperty
```
  The time offset where media should start playing, or restart from when repeating. When playback is stopped, the current time is reset to this value. If this value is positive, then the first time the media is played there might be a delay before playing begins unless the play position can be set to an arbitrary time within the media. This could occur for example for a video which does not contain a lookup table of the offsets of intra-frames in the video stream. In such a case the video frames would need to be skipped over until the position of the first intra-frame before the start time was reached. The default value is Duration.ZERO.
  Constraints: 0 ≤ startTime < stopTime
  
  See Also:
  
  getStartTime(), setStartTime(Duration)
- stopTime
```
public <any> stopTimeProperty
```
  The time offset where media should stop playing or restart when repeating. The default value is getMedia().getDuration().
  Constraints: startTime < stopTime ≤ Media.duration
  
  See Also:
  
  getStopTime(), setStopTime(Duration)
- cycleDuration
```
public <any> cycleDurationProperty
```
  The amount of time between the startTime and stopTime of this player. For the total duration of the Media use the Media.duration property.
  
  See Also:
  
  getCycleDuration()
- totalDuration
```
public <any> totalDurationProperty
```
  The total amount of play time if allowed to play until finished. If cycleCount is set to INDEFINITE then this will also be INDEFINITE. If the Media duration is UNKNOWN, then this will likewise be UNKNOWN. Otherwise, total duration will be the product of cycleDuration and cycleCount.
  
  See Also:
  
  getTotalDuration()
- currentTime
```
public <any> currentTimeProperty
```
  The current media playback time. This property is read-only: use #seek(javafx.util.Duration) to change playback to a different stream position.
  
  See Also:
  
  getCurrentTime()
- status
```
public <any> statusProperty
```
  The current state of the MediaPlayer.
  
  See Also:
  
  getStatus()
- bufferProgressTime
```
public <any> bufferProgressTimeProperty
```
  The current buffer position indicating how much media can be played without stalling the MediaPlayer. This is applicable to buffered streams such as those reading from network connections as opposed for example to local files.
  Seeking to a position beyond bufferProgressTime might cause a slight pause in playback until an amount of data sufficient to permit playback resumption has been buffered.
  
  See Also:
  
  getBufferProgressTime()
- cycleCount
```
public IntegerProperty cycleCountProperty
```
  The number of times the media will be played. By default, cycleCount is set to 1 meaning the media will only be played once. Setting cycleCount to a value greater than 1 will cause the media to play the given number of times or until stopped. If set to INDEFINITE, playback will repeat until stop() or pause() is called.
  constraints: cycleCount ≥ 1
  
  See Also:
  
  getCycleCount(), setCycleCount(int)
- currentCount
```
public ReadOnlyIntegerProperty currentCountProperty
```
  The number of completed playback cycles. On the first pass, the value should be 0. On the second pass, the value should be 1 and so on. It is incremented at the end of each cycle just prior to seeking back to startTime, i.e., when stopTime or the end of media has been reached.
  
  See Also:
  
  getCurrentCount()
- mute
```
public BooleanProperty muteProperty
```
  Whether the player audio is muted. A value of true indicates that audio is not being produced. The value of this property has no effect on volume, i.e., if the audio is muted and then un-muted, audio playback will resume at the same audible level provided of course that the volume property has not been modified meanwhile. The default value is false.
  
  See Also:
  
  isMute(), setMute(boolean)
- onMarker
```
public <any> onMarkerProperty
```
  Event handler invoked when the player currentTime reaches a media marker.
  
  See Also:
  
  getOnMarker(), #setOnMarker()
- onEndOfMedia
```
public <any> onEndOfMediaProperty
```
  Event handler invoked when the player currentTime reaches stopTime.
  
  See Also:
  
  getOnEndOfMedia(), setOnEndOfMedia(Runnable)
- onReady
```
public <any> onReadyProperty
```
  Event handler invoked when the status changes to READY.
  
  See Also:
  
  getOnReady(), setOnReady(Runnable)
- onPlaying
```
public <any> onPlayingProperty
```
  Event handler invoked when the status changes to PLAYING.
  
  See Also:
  
  getOnPlaying(), setOnPlaying(Runnable)
- onPaused
```
public <any> onPausedProperty
```
  Event handler invoked when the status changes to PAUSED.
  
  See Also:
  
  getOnPaused(), setOnPaused(Runnable)
- onStopped
```
public <any> onStoppedProperty
```
  Event handler invoked when the status changes to STOPPED.
  
  See Also:
  
  getOnStopped(), setOnStopped(Runnable)
- onHalted
```
public <any> onHaltedProperty
```
  Event handler invoked when the status changes to HALTED.
  
  See Also:
  
  getOnHalted(), setOnHalted(Runnable)
- onRepeat
```
public <any> onRepeatProperty
```
  Event handler invoked when the player currentTime reaches stopTime and will be repeating. This callback is made prior to seeking back to startTime.
  
  See Also:
  
  getOnRepeat(), setOnRepeat(Runnable)
- onStalled
```
public <any> onStalledProperty
```
  Event handler invoked when the status changes to STALLED.
  
  See Also:
  
  getOnStalled(), setOnStalled(Runnable)
- audioSpectrumNumBands
```
public IntegerProperty audioSpectrumNumBandsProperty
```
  The number of bands in the audio spectrum. The default value is 128; minimum is 2. The frequency range of the audio signal will be divided into the specified number of frequency bins. For example, a typical digital music signal has a frequency range of [0.0, 22050] Hz. If the number of spectral bands were in this case set to 10, the width of each frequency bin in the spectrum would be 2205 Hz with the lower bound of the lowest frequency bin equal to 0.0.
  
  See Also:
  
  getAudioSpectrumNumBands(), setAudioSpectrumNumBands(int)
- audioSpectrumInterval
```
public DoubleProperty audioSpectrumIntervalProperty
```
  The interval between spectrum updates in seconds. The default is 0.1 seconds.
  
  See Also:
  
  getAudioSpectrumInterval(), setAudioSpectrumInterval(double)
- audioSpectrumThreshold
```
public IntegerProperty audioSpectrumThresholdProperty
```
  The sensitivity threshold in decibels; must be non-positive. Values below this threshold with respect to the peak frequency in the given spectral band will be set to the value of the threshold. The default value is -60 dB.
  
  See Also:
  
  getAudioSpectrumThreshold(), setAudioSpectrumThreshold(int)
- audioSpectrumListener
```
public <any> audioSpectrumListenerProperty
```
  A listener for audio spectrum updates. When the listener is registered, audio spectrum computation is enabled; upon removing the listener, computation is disabled. Only a single listener may be registered, so if multiple observers are required, events must be forwarded.
  An AudioSpectrumListener may be useful for example to plot the frequency spectrum of the audio being played or to generate waveforms for a music visualizer.
  
  See Also:
  
  getAudioSpectrumListener(), setAudioSpectrumListener(AudioSpectrumListener)

Field Detail
- INDEFINITE
```
public static final int INDEFINITE
```
  A value representing an effectively infinite number of playback cycles. When cycleCount is set to this value, the player will replay the Media until stopped or paused.
  
  See Also:
  
  Constant Field Values
- RATE_MIN
```
private static final double RATE_MIN
```
  See Also:
  
  Constant Field Values
- RATE_MAX
```
private static final double RATE_MAX
```
  See Also:
  
  Constant Field Values
- AUDIOSPECTRUM_THRESHOLD_MAX
```
private static final int AUDIOSPECTRUM_THRESHOLD_MAX
```
  See Also:
  
  Constant Field Values
- AUDIOSPECTRUM_INTERVAL_MIN
```
private static final double AUDIOSPECTRUM_INTERVAL_MIN
```
  See Also:
  
  Constant Field Values
- AUDIOSPECTRUM_NUMBANDS_MIN
```
private static final int AUDIOSPECTRUM_NUMBANDS_MIN
```
  See Also:
  
  Constant Field Values
- jfxPlayer
```
private com.sun.media.jfxmedia.MediaPlayer jfxPlayer
```
- markerMapListener
```
private <any> markerMapListener
```
- markerEventListener
```
private MarkerListener markerEventListener
```
- stateListener
```
private PlayerStateListener stateListener
```
- timeListener
```
private PlayerTimeListener timeListener
```
- sizeListener
```
private VideoTrackSizeListener sizeListener
```
- errorListener
```
private com.sun.media.jfxmedia.events.MediaErrorListener errorListener
```
- bufferListener
```
private BufferListener bufferListener
```
- spectrumListener
```
private com.sun.media.jfxmedia.events.AudioSpectrumListener spectrumListener
```
- rendererListener
```
private MediaPlayer.RendererListener rendererListener
```
- rateChangeRequested
```
private boolean rateChangeRequested
```
- volumeChangeRequested
```
private boolean volumeChangeRequested
```
- balanceChangeRequested
```
private boolean balanceChangeRequested
```
- startTimeChangeRequested
```
private boolean startTimeChangeRequested
```
- stopTimeChangeRequested
```
private boolean stopTimeChangeRequested
```
- muteChangeRequested
```
private boolean muteChangeRequested
```
- playRequested
```
private boolean playRequested
```
- audioSpectrumNumBandsChangeRequested
```
private boolean audioSpectrumNumBandsChangeRequested
```
- audioSpectrumIntervalChangeRequested
```
private boolean audioSpectrumIntervalChangeRequested
```
- audioSpectrumThresholdChangeRequested
```
private boolean audioSpectrumThresholdChangeRequested
```
- audioSpectrumEnabledChangeRequested
```
private boolean audioSpectrumEnabledChangeRequested
```
- mediaTimerTask
```
private MediaTimerTask mediaTimerTask
```
- prevTimeMs
```
private double prevTimeMs
```
- isUpdateTimeEnabled
```
private boolean isUpdateTimeEnabled
```
- lastBufferEvent
```
private BufferProgressEvent lastBufferEvent
```
- startTimeAtStop
```
private Duration startTimeAtStop
```
- isEOS
```
private boolean isEOS
```
- disposeLock
```
private final java.lang.Object disposeLock
```
- DEFAULT_SPECTRUM_BAND_COUNT
```
private static final int DEFAULT_SPECTRUM_BAND_COUNT
```
  See Also:
  
  Constant Field Values
- DEFAULT_SPECTRUM_INTERVAL
```
private static final double DEFAULT_SPECTRUM_INTERVAL
```
  See Also:
  
  Constant Field Values
- DEFAULT_SPECTRUM_THRESHOLD
```
private static final int DEFAULT_SPECTRUM_THRESHOLD
```
  See Also:
  
  Constant Field Values
- viewRefs
```
private final java.util.Set<java.lang.ref.WeakReference<MediaView>> viewRefs
```
- audioEqualizer
```
private AudioEqualizer audioEqualizer
```
  The read-only AudioEqualizer associated with this player. The equalizer is enabled by default.
- error
```
private <any> error
```
  Observable property set to a MediaException if an error occurs.
- onError
```
private <any> onError
```
  Event handler invoked when an error occurs.
- media
```
private Media media
```
  The parent Media object; read-only.
  
  See Also:
  
  Media
- autoPlay
```
private BooleanProperty autoPlay
```
  Whether playing should start as soon as possible. For a new player this will occur once the player has reached the READY state. The default value is false.
  
  See Also:
  
  MediaPlayer.Status
- playerReady
```
private boolean playerReady
```
- rate
```
private DoubleProperty rate
```
  The rate at which the media should be played. For example, a rate of 1.0 plays the media at its normal (encoded) playback rate, 2.0 plays back at twice the normal rate, etc. The currently supported range of rates is [0.0, 8.0]. The default value is 1.0.
- currentRate
```
private ReadOnlyDoubleWrapper currentRate
```
  The current rate of playback regardless of settings. For example, if rate is set to 1.0 and the player is paused or stalled, then currentRate will be zero.
- volume
```
private DoubleProperty volume
```
  The volume at which the media should be played. The range of effective values is [0.0 1.0] where 0.0 is inaudible and 1.0 is full volume, which is the default.
- balance
```
private DoubleProperty balance
```
  The balance, or left-right setting, of the audio output. The range of effective values is [-1.0, 1.0] with -1.0 being full left, 0.0 center, and 1.0 full right. The default value is 0.0.
- startTime
```
private <any> startTime
```
  The time offset where media should start playing, or restart from when repeating. When playback is stopped, the current time is reset to this value. If this value is positive, then the first time the media is played there might be a delay before playing begins unless the play position can be set to an arbitrary time within the media. This could occur for example for a video which does not contain a lookup table of the offsets of intra-frames in the video stream. In such a case the video frames would need to be skipped over until the position of the first intra-frame before the start time was reached. The default value is Duration.ZERO.
  Constraints: 0 ≤ startTime < stopTime
- stopTime
```
private <any> stopTime
```
  The time offset where media should stop playing or restart when repeating. The default value is getMedia().getDuration().
  Constraints: startTime < stopTime ≤ Media.duration
- cycleDuration
```
private <any> cycleDuration
```
  The amount of time between the startTime and stopTime of this player. For the total duration of the Media use the Media.duration property.
- totalDuration
```
private <any> totalDuration
```
  The total amount of play time if allowed to play until finished. If cycleCount is set to INDEFINITE then this will also be INDEFINITE. If the Media duration is UNKNOWN, then this will likewise be UNKNOWN. Otherwise, total duration will be the product of cycleDuration and cycleCount.
- currentTime
```
private <any> currentTime
```
  The current media playback time. This property is read-only: use #seek(javafx.util.Duration) to change playback to a different stream position.
- status
```
private <any> status
```
  The current state of the MediaPlayer.
- bufferProgressTime
```
private <any> bufferProgressTime
```
  The current buffer position indicating how much media can be played without stalling the MediaPlayer. This is applicable to buffered streams such as those reading from network connections as opposed for example to local files.
  Seeking to a position beyond bufferProgressTime might cause a slight pause in playback until an amount of data sufficient to permit playback resumption has been buffered.
- cycleCount
```
private IntegerProperty cycleCount
```
  The number of times the media will be played. By default, cycleCount is set to 1 meaning the media will only be played once. Setting cycleCount to a value greater than 1 will cause the media to play the given number of times or until stopped. If set to INDEFINITE, playback will repeat until stop() or pause() is called.
  constraints: cycleCount ≥ 1
- currentCount
```
private ReadOnlyIntegerWrapper currentCount
```
  The number of completed playback cycles. On the first pass, the value should be 0. On the second pass, the value should be 1 and so on. It is incremented at the end of each cycle just prior to seeking back to startTime, i.e., when stopTime or the end of media has been reached.
- mute
```
private BooleanProperty mute
```
  Whether the player audio is muted. A value of true indicates that audio is not being produced. The value of this property has no effect on volume, i.e., if the audio is muted and then un-muted, audio playback will resume at the same audible level provided of course that the volume property has not been modified meanwhile. The default value is false.
  
  See Also:
  
  volume
- onMarker
```
private <any> onMarker
```
  Event handler invoked when the player currentTime reaches a media marker.
- onEndOfMedia
```
private <any> onEndOfMedia
```
  Event handler invoked when the player currentTime reaches stopTime.
- onReady
```
private <any> onReady
```
  Event handler invoked when the status changes to READY.
- onPlaying
```
private <any> onPlaying
```
  Event handler invoked when the status changes to PLAYING.
- onPaused
```
private <any> onPaused
```
  Event handler invoked when the status changes to PAUSED.
- onStopped
```
private <any> onStopped
```
  Event handler invoked when the status changes to STOPPED.
- onHalted
```
private <any> onHalted
```
  Event handler invoked when the status changes to HALTED.
- onRepeat
```
private <any> onRepeat
```
  Event handler invoked when the player currentTime reaches stopTime and will be repeating. This callback is made prior to seeking back to startTime.
  
  See Also:
  
  cycleCount
- onStalled
```
private <any> onStalled
```
  Event handler invoked when the status changes to STALLED.
- audioSpectrumNumBands
```
private IntegerProperty audioSpectrumNumBands
```
  The number of bands in the audio spectrum. The default value is 128; minimum is 2. The frequency range of the audio signal will be divided into the specified number of frequency bins. For example, a typical digital music signal has a frequency range of [0.0, 22050] Hz. If the number of spectral bands were in this case set to 10, the width of each frequency bin in the spectrum would be 2205 Hz with the lower bound of the lowest frequency bin equal to 0.0.
- audioSpectrumInterval
```
private DoubleProperty audioSpectrumInterval
```
  The interval between spectrum updates in seconds. The default is 0.1 seconds.
- audioSpectrumThreshold
```
private IntegerProperty audioSpectrumThreshold
```
  The sensitivity threshold in decibels; must be non-positive. Values below this threshold with respect to the peak frequency in the given spectral band will be set to the value of the threshold. The default value is -60 dB.
- audioSpectrumListener
```
private <any> audioSpectrumListener
```
  A listener for audio spectrum updates. When the listener is registered, audio spectrum computation is enabled; upon removing the listener, computation is disabled. Only a single listener may be registered, so if multiple observers are required, events must be forwarded.
  An AudioSpectrumListener may be useful for example to plot the frequency spectrum of the audio being played or to generate waveforms for a music visualizer.
- renderLock
```
private final java.lang.Object renderLock
```
- currentRenderFrame
```
private VideoDataBuffer currentRenderFrame
```
- nextRenderFrame
```
private VideoDataBuffer nextRenderFrame
```

Constructor Detail
- MediaPlayer
```
public MediaPlayer(Media media)
```
  Create a player for a specific media. This is the only way to associate a Media object with a MediaPlayer: once the player is created it cannot be changed. Errors which occur synchronously within the constructor will cause exceptions to be thrown. Errors which occur asynchronously will cause the error property to be set and consequently any onError callback to be invoked.
  When created, the status of the player will be MediaPlayer.Status.UNKNOWN. Once the status has transitioned to MediaPlayer.Status.READY the player will be in a usable condition. The amount of time between player creation and its entering READY status may vary depending, for example, on whether the media is being read over a network connection or from a local file system.
  
  Parameters:
  
  media - The media to play.
  
  Throws:
  
  java.lang.NullPointerException - if media is null.
  
  MediaException - if any synchronous errors occur within the constructor.

Method Detail

retrieveJfxPlayer

com.sun.media.jfxmedia.MediaPlayer retrieveJfxPlayer()

clamp

private static double clamp(double dvalue,
                            double dmin,
                            double dmax)

clamp

private static int clamp(int ivalue,
                         int imin,
                         int imax)

getAudioEqualizer
```
public final AudioEqualizer getAudioEqualizer()
```
Retrieve the AudioEqualizer associated with this player.

Returns:

the AudioEqualizer or null if player is disposed.

registerListeners
```
void registerListeners()
```

init

private void init()
           throws MediaException

Throws:: MediaException

setError

private void setError(MediaException value)

getError
```
public final MediaException getError()
```
Retrieve the value of the error property or null if there is no error.

Returns:

a MediaException or null.

errorProperty
```
public <any> errorProperty()
```
Observable property set to a MediaException if an error occurs.

See Also:

getError()

errorPropertyImpl
```
private <any> errorPropertyImpl()
```

setOnError
```
public final void setOnError(java.lang.Runnable value)
```
Sets the event handler to be called when an error occurs.

Parameters:

value - the event handler or null.

getOnError
```
public final java.lang.Runnable getOnError()
```
Retrieves the event handler for errors.

Returns:

the event handler.

onErrorProperty
```
public <any> onErrorProperty()
```
Event handler invoked when an error occurs.

See Also:

getOnError(), setOnError(Runnable)

getMedia
```
public final Media getMedia()
```
Retrieves the Media instance being played.

Returns:

the Media object.

setAutoPlay
```
public final void setAutoPlay(boolean value)
```
Sets the autoPlay property value.

Parameters:

value - whether to enable auto-playback

isAutoPlay
```
public final boolean isAutoPlay()
```
Retrieves the autoPlay property value.

Returns:

the value.

autoPlayProperty
```
public BooleanProperty autoPlayProperty()
```
Whether playing should start as soon as possible. For a new player this will occur once the player has reached the READY state. The default value is false.

See Also:

isAutoPlay(), setAutoPlay(boolean)

play
```
public void play()
```
Starts playing the media. If previously paused, then playback resumes where it was paused. If playback was stopped, playback starts from the startTime. When playing actually starts the status will be set to MediaPlayer.Status.PLAYING.

pause
```
public void pause()
```
Pauses the player. Once the player is actually paused the status will be set to MediaPlayer.Status.PAUSED.

stop
```
public void stop()
```
Stops playing the media. This operation resets playback to startTime, and resets currentCount to zero. Once the player is actually stopped, the status will be set to MediaPlayer.Status.STOPPED. The only transitions out of STOPPED status are to MediaPlayer.Status.PAUSED and MediaPlayer.Status.PLAYING which occur after invoking pause() or play(), respectively. While stopped, the player will not respond to playback position changes requested by #seek(javafx.util.Duration).

setRate
```
public final void setRate(double value)
```
Sets the playback rate to the supplied value. Its effect will be clamped to the range [0.0, 8.0]. Invoking this method will have no effect if media duration is Duration#INDEFINITE.

Parameters:

value - the playback rate

getRate
```
public final double getRate()
```
Retrieves the playback rate.

Returns:

the playback rate

rateProperty
```
public DoubleProperty rateProperty()
```
The rate at which the media should be played. For example, a rate of 1.0 plays the media at its normal (encoded) playback rate, 2.0 plays back at twice the normal rate, etc. The currently supported range of rates is [0.0, 8.0]. The default value is 1.0.

See Also:

getRate(), setRate(double)

setCurrentRate

private void setCurrentRate(double value)

getCurrentRate
```
public final double getCurrentRate()
```
Retrieves the current playback rate.

Returns:

the current rate

currentRateProperty
```
public ReadOnlyDoubleProperty currentRateProperty()
```
The current rate of playback regardless of settings. For example, if rate is set to 1.0 and the player is paused or stalled, then currentRate will be zero.

See Also:

getCurrentRate()

currentRatePropertyImpl

private ReadOnlyDoubleWrapper currentRatePropertyImpl()

setVolume
```
public final void setVolume(double value)
```
Sets the audio playback volume. Its effect will be clamped to the range [0.0, 1.0].

Parameters:

value - the volume

getVolume
```
public final double getVolume()
```
Retrieves the audio playback volume. The default value is 1.0.

Returns:

the audio volume

volumeProperty
```
public DoubleProperty volumeProperty()
```
The volume at which the media should be played. The range of effective values is [0.0 1.0] where 0.0 is inaudible and 1.0 is full volume, which is the default.

See Also:

getVolume(), setVolume(double)

setBalance
```
public final void setBalance(double value)
```
Sets the audio balance. Its effect will be clamped to the range [-1.0, 1.0].

Parameters:

value - the balance

getBalance
```
public final double getBalance()
```
Retrieves the audio balance.

Returns:

the audio balance

balanceProperty
```
public DoubleProperty balanceProperty()
```
The balance, or left-right setting, of the audio output. The range of effective values is [-1.0, 1.0] with -1.0 being full left, 0.0 center, and 1.0 full right. The default value is 0.0.

See Also:

getBalance(), setBalance(double)

calculateStartStopTimes
```
private double[] calculateStartStopTimes(Duration startValue,
                                         Duration stopValue)
```
Behaviorally clamp the start and stop times. The parameters are clamped to the range [0.0, duration]. If the duration is not known, Double.MAX_VALUE is used instead. Furthermore, if the separately clamped values satisfy startTime > stopTime then stopTime is clamped as stopTime ≥ startTime.

Parameters:

startValue - the new start time.

stopValue - the new stop time.

Returns:

the clamped times in seconds as {actualStart, actualStop}.

setStartStopTimes

private void setStartStopTimes(Duration startValue,
                               boolean isStartValueSet,
                               Duration stopValue,
                               boolean isStopValueSet)

Set the effective start and stop times on the underlying player, clamping as needed.

Parameters:: startValue - the new start time.; stopValue - the new stop time.

setStartTime
```
public final void setStartTime(Duration value)
```
Sets the start time. Its effect will be clamped to the range [Duration#ZERO, stopTime). Invoking this method will have no effect if media duration is Duration#INDEFINITE.

Parameters:

value - the start time

getStartTime
```
public final Duration getStartTime()
```
Retrieves the start time. The default value is Duration.ZERO.

Returns:

the start time

startTimeProperty
```
public <any> startTimeProperty()
```
The time offset where media should start playing, or restart from when repeating. When playback is stopped, the current time is reset to this value. If this value is positive, then the first time the media is played there might be a delay before playing begins unless the play position can be set to an arbitrary time within the media. This could occur for example for a video which does not contain a lookup table of the offsets of intra-frames in the video stream. In such a case the video frames would need to be skipped over until the position of the first intra-frame before the start time was reached. The default value is Duration.ZERO.
Constraints: 0 ≤ startTime < stopTime

See Also:

getStartTime(), setStartTime(Duration)

setStopTime
```
public final void setStopTime(Duration value)
```
Sets the stop time. Its effect will be clamped to the range (startTime, Media.duration]. Invoking this method will have no effect if media duration is Duration#INDEFINITE.

Parameters:

value - the stop time

getStopTime
```
public final Duration getStopTime()
```
Retrieves the stop time. The default value is getMedia().getDuration(). Note that Media.duration may have the value Duration.UNKNOWN if media initialization is not complete.

Returns:

the stop time

stopTimeProperty
```
public <any> stopTimeProperty()
```
The time offset where media should stop playing or restart when repeating. The default value is getMedia().getDuration().
Constraints: startTime < stopTime ≤ Media.duration

See Also:

getStopTime(), setStopTime(Duration)

setCycleDuration

private void setCycleDuration(Duration value)

getCycleDuration
```
public final Duration getCycleDuration()
```
Retrieves the cycle duration in seconds.

Returns:

the cycle duration

cycleDurationProperty
```
public <any> cycleDurationProperty()
```
The amount of time between the startTime and stopTime of this player. For the total duration of the Media use the Media.duration property.

See Also:

getCycleDuration()

cycleDurationPropertyImpl

private <any> cycleDurationPropertyImpl()

calculateCycleDuration
```
private void calculateCycleDuration()
```

setTotalDuration

private void setTotalDuration(Duration value)

getTotalDuration
```
public final Duration getTotalDuration()
```
Retrieves the total playback duration including all cycles (repetitions).

Returns:

the total playback duration

totalDurationProperty
```
public <any> totalDurationProperty()
```
The total amount of play time if allowed to play until finished. If cycleCount is set to INDEFINITE then this will also be INDEFINITE. If the Media duration is UNKNOWN, then this will likewise be UNKNOWN. Otherwise, total duration will be the product of cycleDuration and cycleCount.

See Also:

getTotalDuration()

totalDurationPropertyImpl

private <any> totalDurationPropertyImpl()

calculateTotalDuration
```
private void calculateTotalDuration()
```

setCurrentTime

private void setCurrentTime(Duration value)

getCurrentTime
```
public final Duration getCurrentTime()
```
Retrieves the current media time.

Returns:

the current media time

currentTimeProperty
```
public <any> currentTimeProperty()
```
The current media playback time. This property is read-only: use #seek(javafx.util.Duration) to change playback to a different stream position.

See Also:

getCurrentTime()

currentTimePropertyImpl

private <any> currentTimePropertyImpl()

seek

public void seek(Duration seekTime)

Seeks the player to a new playback time. Invoking this method will have no effect while the player status is MediaPlayer.Status.STOPPED or media duration is Duration#INDEFINITE.

The behavior of seek() is constrained as follows where start time and stop time indicate the effective lower and upper bounds, respectively, of media playback:

MediaPlayer Seek Table
seekTime	seek position
`null`	no change
`Duration#UNKNOWN`	no change
`Duration#INDEFINITE`	stop time
seekTime < start time	start time
seekTime > stop time	stop time
start time ≤ seekTime ≤ stop time	seekTime

Parameters:: seekTime - the requested playback time

setStatus

private void setStatus(MediaPlayer.Status value)

getStatus
```
public final MediaPlayer.Status getStatus()
```
Retrieves the current player status.

Returns:

the playback status

statusProperty
```
public <any> statusProperty()
```
The current state of the MediaPlayer.

See Also:

getStatus()

statusPropertyImpl
```
private <any> statusPropertyImpl()
```

setBufferProgressTime

private void setBufferProgressTime(Duration value)

getBufferProgressTime
```
public final Duration getBufferProgressTime()
```
Retrieves the bufferProgressTime value.

Returns:

the buffer progress time

bufferProgressTimeProperty
```
public <any> bufferProgressTimeProperty()
```
The current buffer position indicating how much media can be played without stalling the MediaPlayer. This is applicable to buffered streams such as those reading from network connections as opposed for example to local files.
Seeking to a position beyond bufferProgressTime might cause a slight pause in playback until an amount of data sufficient to permit playback resumption has been buffered.

See Also:

getBufferProgressTime()

bufferProgressTimePropertyImpl

private <any> bufferProgressTimePropertyImpl()

setCycleCount
```
public final void setCycleCount(int value)
```
Sets the cycle count. Its effect will be constrained to [1,Integer.MAX_VALUE]. Invoking this method will have no effect if media duration is Duration#INDEFINITE.

Parameters:

value - the cycle count

getCycleCount
```
public final int getCycleCount()
```
Retrieves the cycle count.

Returns:

the cycle count.

cycleCountProperty
```
public IntegerProperty cycleCountProperty()
```
The number of times the media will be played. By default, cycleCount is set to 1 meaning the media will only be played once. Setting cycleCount to a value greater than 1 will cause the media to play the given number of times or until stopped. If set to INDEFINITE, playback will repeat until stop() or pause() is called.
constraints: cycleCount ≥ 1

See Also:

getCycleCount(), setCycleCount(int)

setCurrentCount

private void setCurrentCount(int value)

getCurrentCount
```
public final int getCurrentCount()
```
Retrieves the index of the current cycle.

Returns:

the current cycle index

currentCountProperty
```
public ReadOnlyIntegerProperty currentCountProperty()
```
The number of completed playback cycles. On the first pass, the value should be 0. On the second pass, the value should be 1 and so on. It is incremented at the end of each cycle just prior to seeking back to startTime, i.e., when stopTime or the end of media has been reached.

See Also:

getCurrentCount()

currentCountPropertyImpl

private ReadOnlyIntegerWrapper currentCountPropertyImpl()

setMute
```
public final void setMute(boolean value)
```
Sets the value of muteProperty().

Parameters:

value - the mute setting

isMute
```
public final boolean isMute()
```
Retrieves the muteProperty() value.

Returns:

the mute setting

muteProperty
```
public BooleanProperty muteProperty()
```
Whether the player audio is muted. A value of true indicates that audio is not being produced. The value of this property has no effect on volume, i.e., if the audio is muted and then un-muted, audio playback will resume at the same audible level provided of course that the volume property has not been modified meanwhile. The default value is false.

See Also:

isMute(), setMute(boolean)

setOnMarker
```
public final void setOnMarker(<any> onMarker)
```
Sets the marker event handler.

Parameters:

onMarker - the marker event handler.

getOnMarker
```
public final <any> getOnMarker()
```
Retrieves the marker event handler.

Returns:

the marker event handler.

onMarkerProperty
```
public <any> onMarkerProperty()
```
Event handler invoked when the player currentTime reaches a media marker.

See Also:

getOnMarker(), #setOnMarker()

addView
```
void addView(MediaView view)
```

removeView
```
void removeView(MediaView view)
```

handleError

void handleError(MediaException error)

createMediaTimer
```
void createMediaTimer()
```

destroyMediaTimer
```
void destroyMediaTimer()
```

updateTime
```
void updateTime()
```

loopPlayback
```
void loopPlayback()
```

handleRequestedChanges
```
void handleRequestedChanges()
```

preReady
```
void preReady()
```

setOnEndOfMedia
```
public final void setOnEndOfMedia(java.lang.Runnable value)
```
Sets the end of media event handler.

Parameters:

value - the event handler or null.

getOnEndOfMedia
```
public final java.lang.Runnable getOnEndOfMedia()
```
Retrieves the end of media event handler.

Returns:

the event handler or null.

onEndOfMediaProperty
```
public <any> onEndOfMediaProperty()
```
Event handler invoked when the player currentTime reaches stopTime.

See Also:

getOnEndOfMedia(), setOnEndOfMedia(Runnable)

setOnReady
```
public final void setOnReady(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.READY event handler.

Parameters:

value - the event handler or null.

getOnReady
```
public final java.lang.Runnable getOnReady()
```
Retrieves the MediaPlayer.Status.READY event handler.

Returns:

the event handler or null.

onReadyProperty
```
public <any> onReadyProperty()
```
Event handler invoked when the status changes to READY.

See Also:

getOnReady(), setOnReady(Runnable)

setOnPlaying
```
public final void setOnPlaying(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.PLAYING event handler.

Parameters:

value - the event handler or null.

getOnPlaying
```
public final java.lang.Runnable getOnPlaying()
```
Retrieves the MediaPlayer.Status.PLAYING event handler.

Returns:

the event handler or null.

onPlayingProperty
```
public <any> onPlayingProperty()
```
Event handler invoked when the status changes to PLAYING.

See Also:

getOnPlaying(), setOnPlaying(Runnable)

setOnPaused
```
public final void setOnPaused(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.PAUSED event handler.

Parameters:

value - the event handler or null.

getOnPaused
```
public final java.lang.Runnable getOnPaused()
```
Retrieves the MediaPlayer.Status.PAUSED event handler.

Returns:

the event handler or null.

onPausedProperty
```
public <any> onPausedProperty()
```
Event handler invoked when the status changes to PAUSED.

See Also:

getOnPaused(), setOnPaused(Runnable)

setOnStopped
```
public final void setOnStopped(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.STOPPED event handler.

Parameters:

value - the event handler or null.

getOnStopped
```
public final java.lang.Runnable getOnStopped()
```
Retrieves the MediaPlayer.Status.STOPPED event handler.

Returns:

the event handler or null.

onStoppedProperty
```
public <any> onStoppedProperty()
```
Event handler invoked when the status changes to STOPPED.

See Also:

getOnStopped(), setOnStopped(Runnable)

setOnHalted
```
public final void setOnHalted(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.HALTED event handler.

Parameters:

value - the event handler or null.

getOnHalted
```
public final java.lang.Runnable getOnHalted()
```
Retrieves the MediaPlayer.Status.HALTED event handler.

Returns:

the event handler or null.

onHaltedProperty
```
public <any> onHaltedProperty()
```
Event handler invoked when the status changes to HALTED.

See Also:

getOnHalted(), setOnHalted(Runnable)

setOnRepeat
```
public final void setOnRepeat(java.lang.Runnable value)
```
Sets the repeat event handler.

Parameters:

value - the event handler or null.

getOnRepeat
```
public final java.lang.Runnable getOnRepeat()
```
Retrieves the repeat event handler.

Returns:

the event handler or null.

onRepeatProperty
```
public <any> onRepeatProperty()
```
Event handler invoked when the player currentTime reaches stopTime and will be repeating. This callback is made prior to seeking back to startTime.

See Also:

getOnRepeat(), setOnRepeat(Runnable)

setOnStalled
```
public final void setOnStalled(java.lang.Runnable value)
```
Sets the MediaPlayer.Status.STALLED event handler.

Parameters:

value - the event handler or null.

getOnStalled
```
public final java.lang.Runnable getOnStalled()
```
Retrieves the MediaPlayer.Status.STALLED event handler.

Returns:

the event handler or null.

onStalledProperty
```
public <any> onStalledProperty()
```
Event handler invoked when the status changes to STALLED.

See Also:

getOnStalled(), setOnStalled(Runnable)

setAudioSpectrumNumBands
```
public final void setAudioSpectrumNumBands(int value)
```
Sets the number of bands in the audio spectrum.

Parameters:

value - the number of spectral bands; valuemust be ≥ 2

getAudioSpectrumNumBands
```
public final int getAudioSpectrumNumBands()
```
Retrieves the number of bands in the audio spectrum.

Returns:

the number of spectral bands.

audioSpectrumNumBandsProperty
```
public IntegerProperty audioSpectrumNumBandsProperty()
```
The number of bands in the audio spectrum. The default value is 128; minimum is 2. The frequency range of the audio signal will be divided into the specified number of frequency bins. For example, a typical digital music signal has a frequency range of [0.0, 22050] Hz. If the number of spectral bands were in this case set to 10, the width of each frequency bin in the spectrum would be 2205 Hz with the lower bound of the lowest frequency bin equal to 0.0.

See Also:

getAudioSpectrumNumBands(), setAudioSpectrumNumBands(int)

setAudioSpectrumInterval
```
public final void setAudioSpectrumInterval(double value)
```
Sets the value of the audio spectrum notification interval in seconds.

Parameters:

value - a positive value specifying the spectral update interval

getAudioSpectrumInterval
```
public final double getAudioSpectrumInterval()
```
Retrieves the value of the audio spectrum notification interval in seconds.

Returns:

the spectral update interval

audioSpectrumIntervalProperty
```
public DoubleProperty audioSpectrumIntervalProperty()
```
The interval between spectrum updates in seconds. The default is 0.1 seconds.

See Also:

getAudioSpectrumInterval(), setAudioSpectrumInterval(double)

setAudioSpectrumThreshold
```
public final void setAudioSpectrumThreshold(int value)
```
Sets the audio spectrum threshold in decibels.

Parameters:

value - the spectral threshold in dB; must be ≤ 0.

getAudioSpectrumThreshold
```
public final int getAudioSpectrumThreshold()
```
Retrieves the audio spectrum threshold in decibels.

Returns:

the spectral threshold in dB

audioSpectrumThresholdProperty
```
public IntegerProperty audioSpectrumThresholdProperty()
```
The sensitivity threshold in decibels; must be non-positive. Values below this threshold with respect to the peak frequency in the given spectral band will be set to the value of the threshold. The default value is -60 dB.

See Also:

getAudioSpectrumThreshold(), setAudioSpectrumThreshold(int)

setAudioSpectrumListener
```
public final void setAudioSpectrumListener(AudioSpectrumListener listener)
```
Sets the listener of the audio spectrum.

Parameters:

listener - the spectral listener or null.

getAudioSpectrumListener
```
public final AudioSpectrumListener getAudioSpectrumListener()
```
Retrieves the listener of the audio spectrum.

Returns:

the spectral listener or null

audioSpectrumListenerProperty
```
public <any> audioSpectrumListenerProperty()
```
A listener for audio spectrum updates. When the listener is registered, audio spectrum computation is enabled; upon removing the listener, computation is disabled. Only a single listener may be registered, so if multiple observers are required, events must be forwarded.
An AudioSpectrumListener may be useful for example to plot the frequency spectrum of the audio being played or to generate waveforms for a music visualizer.

See Also:

getAudioSpectrumListener(), setAudioSpectrumListener(AudioSpectrumListener)

dispose
```
public void dispose()
```
Free all resources associated with player. Player SHOULD NOT be used after this function is called. Player will transition to MediaPlayer.Status.DISPOSED after this method is done. This method can be called anytime regardless of current player status.

Since:

JavaFX 8.0

getLatestFrame
```
VideoDataBuffer getLatestFrame()
```
WARNING: You must call releaseFrame() on the returned frame when you are finished with it or a massive memory leak will occur.

Returns:

the current frame to be used for rendering, or null if not in a render cycle

Class MediaPlayer

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

error

onError

autoPlay

rate

currentRate

volume

balance

startTime

stopTime

cycleDuration

totalDuration

currentTime

status

bufferProgressTime

cycleCount

currentCount

mute

onMarker

onEndOfMedia

onReady

onPlaying

onPaused

onStopped

onHalted

onRepeat

onStalled

audioSpectrumNumBands

audioSpectrumInterval

audioSpectrumThreshold

audioSpectrumListener

Field Detail

INDEFINITE

RATE_MIN

RATE_MAX

AUDIOSPECTRUM_THRESHOLD_MAX

AUDIOSPECTRUM_INTERVAL_MIN

AUDIOSPECTRUM_NUMBANDS_MIN

jfxPlayer

markerMapListener

markerEventListener

stateListener

timeListener

sizeListener

errorListener

bufferListener

spectrumListener

rendererListener

rateChangeRequested

volumeChangeRequested

balanceChangeRequested

startTimeChangeRequested

stopTimeChangeRequested

muteChangeRequested

playRequested

audioSpectrumNumBandsChangeRequested

audioSpectrumIntervalChangeRequested

audioSpectrumThresholdChangeRequested

audioSpectrumEnabledChangeRequested

mediaTimerTask

prevTimeMs

isUpdateTimeEnabled

lastBufferEvent

startTimeAtStop

isEOS

disposeLock

DEFAULT_SPECTRUM_BAND_COUNT

DEFAULT_SPECTRUM_INTERVAL

DEFAULT_SPECTRUM_THRESHOLD

viewRefs

audioEqualizer

error

onError