Package javafx.scene.media

Class MediaPlayer

java.lang.Object

javafx.scene.media.MediaPlayer

public class MediaPlayer
extends Object

Author:

Bruno Salmon

Property Summary

Properties

Type	Property	Description
ObjectProperty<Duration>	currentTime
ObjectProperty<Runnable>	onEndOfMedia
ObjectProperty<Runnable>	onHalted	Event handler invoked when the status changes to HALTED.
ObjectProperty<Runnable>	onPaused	Event handler invoked when the status changes to PAUSED.
ObjectProperty<Runnable>	onPlaying	Event handler invoked when the status changes to PLAYING.
ObjectProperty<Runnable>	onReady	Event handler invoked when the status changes to READY.
ObjectProperty<Runnable>	onRepeat	Event handler invoked when the player currentTime reaches stopTime and will be repeating.
ObjectProperty<Runnable>	onStalled	Event handler invoked when the status changes to STALLED.
ObjectProperty<Runnable>	onStopped	Event handler invoked when the status changes to STOPPED.
ReadOnlyObjectProperty<MediaPlayer.Status>	status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MediaPlayer.Status	Enumeration describing the different status values of a MediaPlayer.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INDEFINITE

Constructor Summary

Constructors

Constructor	Description
MediaPlayer(Media media)

Method Summary

Modifier and Type	Method	Description
ObjectProperty<Duration>	currentTimeProperty()
void	dispose()
final Duration	getCurrentTime()	Gets the value of the currentTime property.
int	getCycleCount()
Media	getMedia()
final Runnable	getOnEndOfMedia()	Retrieves the end of media event handler.
final Runnable	getOnHalted()	Retrieves the MediaPlayer.Status.HALTED event handler.
final Runnable	getOnPaused()	Retrieves the MediaPlayer.Status.PAUSED event handler.
final Runnable	getOnPlaying()	Retrieves the MediaPlayer.Status.PLAYING event handler.
final Runnable	getOnReady()	Retrieves the MediaPlayer.Status.READY event handler.
final Runnable	getOnRepeat()	Retrieves the repeat event handler.
final Runnable	getOnStalled()	Retrieves the MediaPlayer.Status.STALLED event handler.
final Runnable	getOnStopped()	Retrieves the MediaPlayer.Status.STOPPED event handler.
MediaPlayerPeer	getPeer()
MediaPlayer.Status	getStatus()	Gets the value of the status property.
ObjectProperty<Runnable>	onEndOfMediaProperty()
ObjectProperty<Runnable>	onHaltedProperty()	Event handler invoked when the status changes to HALTED.
ObjectProperty<Runnable>	onPausedProperty()	Event handler invoked when the status changes to PAUSED.
ObjectProperty<Runnable>	onPlayingProperty()	Event handler invoked when the status changes to PLAYING.
ObjectProperty<Runnable>	onReadyProperty()	Event handler invoked when the status changes to READY.
ObjectProperty<Runnable>	onRepeatProperty()	Event handler invoked when the player currentTime reaches stopTime and will be repeating.
ObjectProperty<Runnable>	onStalledProperty()	Event handler invoked when the status changes to STALLED.
ObjectProperty<Runnable>	onStoppedProperty()	Event handler invoked when the status changes to STOPPED.
void	pause()
void	play()
void	seek(Duration duration)
final void	setAudioSpectrumInterval(double value)	Sets the value of the audio spectrum notification interval in seconds.
final void	setAudioSpectrumListener(AudioSpectrumListener listener)
final void	setAudioSpectrumNumBands(int value)	Sets the number of bands in the audio spectrum.
void	setCycleCount(int cycleCount)
final void	setMute(boolean mute)
final void	setOnEndOfMedia(Runnable value)	Sets the end of media event handler.
final void	setOnHalted(Runnable value)	Sets the MediaPlayer.Status.HALTED event handler.
final void	setOnPaused(Runnable value)	Sets the MediaPlayer.Status.PAUSED event handler.
final void	setOnPlaying(Runnable value)	Sets the MediaPlayer.Status.PLAYING event handler.
final void	setOnReady(Runnable value)	Sets the MediaPlayer.Status.READY event handler.
final void	setOnRepeat(Runnable value)	Sets the repeat event handler.
final void	setOnStalled(Runnable value)	Sets the MediaPlayer.Status.STALLED event handler.
final void	setOnStopped(Runnable value)	Sets the MediaPlayer.Status.STOPPED event handler.
void	setStatus(MediaPlayer.Status status)	Sets the value of the status property.
void	setVolume(double volume)
ReadOnlyObjectProperty<MediaPlayer.Status>	statusProperty()
void	stop()

Methods inherited from class java.lang.Object

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

Property Details

currentTime

public ObjectProperty<Duration> currentTimeProperty

See Also:

• getCurrentTime()
• currentTimeProperty()

status

public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty

See Also:

• getStatus()
• setStatus(MediaPlayer.Status)
• statusProperty()

onEndOfMedia

public ObjectProperty<Runnable> onEndOfMediaProperty

See Also:

• getOnEndOfMedia()
• setOnEndOfMedia(Runnable)
• onEndOfMediaProperty()

onReady

public ObjectProperty<Runnable> onReadyProperty

Event handler invoked when the status changes to READY.

See Also:

• getOnReady()
• setOnReady(Runnable)
• onReadyProperty()

onPlaying

public ObjectProperty<Runnable> onPlayingProperty

Event handler invoked when the status changes to PLAYING.

See Also:

• getOnPlaying()
• setOnPlaying(Runnable)
• onPlayingProperty()

onPaused

public ObjectProperty<Runnable> onPausedProperty

Event handler invoked when the status changes to PAUSED.

See Also:

• getOnPaused()
• setOnPaused(Runnable)
• onPausedProperty()

onStopped

public ObjectProperty<Runnable> onStoppedProperty

Event handler invoked when the status changes to STOPPED.

See Also:

• getOnStopped()
• setOnStopped(Runnable)
• onStoppedProperty()

onHalted

public ObjectProperty<Runnable> onHaltedProperty

Event handler invoked when the status changes to HALTED.

See Also:

• getOnHalted()
• setOnHalted(Runnable)
• onHaltedProperty()

onRepeat

public ObjectProperty<Runnable> 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)
• onRepeatProperty()

onStalled

public ObjectProperty<Runnable> onStalledProperty

Event handler invoked when the status changes to STALLED.

See Also:

• getOnStalled()
• setOnStalled(Runnable)
• onStalledProperty()

Field Details

INDEFINITE

public static final int INDEFINITE

See Also:

• Constant Field Values

Constructor Details

MediaPlayer

public MediaPlayer(Media media)

Method Details

getPeer

public MediaPlayerPeer getPeer()

getMedia

public Media getMedia()

setCycleCount

public void setCycleCount(int cycleCount)

getCycleCount

public int getCycleCount()

play

public void play()

pause

public void pause()

stop

public void stop()

dispose

public void dispose()

setVolume

public void setVolume(double volume)

setMute

public final void setMute(boolean mute)

getCurrentTime

public final Duration getCurrentTime()

Gets the value of the currentTime property.

Property description:

Returns:

the value of the currentTime property

See Also:

• currentTimeProperty()

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

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

setAudioSpectrumListener

public final void setAudioSpectrumListener(AudioSpectrumListener listener)

currentTimeProperty

public ObjectProperty<Duration> currentTimeProperty()

Returns:

the currentTime property

See Also:

• getCurrentTime()

seek

public void seek(Duration duration)

statusProperty

public ReadOnlyObjectProperty<MediaPlayer.Status> statusProperty()

Returns:

the status property

See Also:

• getStatus()
• setStatus(MediaPlayer.Status)

getStatus

public MediaPlayer.Status getStatus()

Gets the value of the status property.

Property description:

Returns:

the value of the status property

See Also:

• setStatus(MediaPlayer.Status)
• statusProperty()

setOnEndOfMedia

public final void setOnEndOfMedia(Runnable value)

Sets the end of media event handler.

Parameters:

value - the event handler or null.

getOnEndOfMedia

public final Runnable getOnEndOfMedia()

Retrieves the end of media event handler.

Returns:

the event handler or null.

onEndOfMediaProperty

public ObjectProperty<Runnable> onEndOfMediaProperty()

Returns:

the onEndOfMedia property

See Also:

• getOnEndOfMedia()
• setOnEndOfMedia(Runnable)

setOnReady

public final void setOnReady(Runnable value)

Sets the MediaPlayer.Status.READY event handler.

Parameters:

value - the event handler or null.

getOnReady

public final Runnable getOnReady()

Retrieves the MediaPlayer.Status.READY event handler.

Returns:

the event handler or null.

onReadyProperty

public ObjectProperty<Runnable> onReadyProperty()

Event handler invoked when the status changes to READY.

Returns:

the onReady property

See Also:

• getOnReady()
• setOnReady(Runnable)

setOnPlaying

public final void setOnPlaying(Runnable value)

Sets the MediaPlayer.Status.PLAYING event handler.

Parameters:

value - the event handler or null.

getOnPlaying

public final Runnable getOnPlaying()

Retrieves the MediaPlayer.Status.PLAYING event handler.

Returns:

the event handler or null.

onPlayingProperty

public ObjectProperty<Runnable> onPlayingProperty()

Event handler invoked when the status changes to PLAYING.

Returns:

the onPlaying property

See Also:

• getOnPlaying()
• setOnPlaying(Runnable)

setOnPaused

public final void setOnPaused(Runnable value)

Sets the MediaPlayer.Status.PAUSED event handler.

Parameters:

value - the event handler or null.

getOnPaused

public final Runnable getOnPaused()

Retrieves the MediaPlayer.Status.PAUSED event handler.

Returns:

the event handler or null.

onPausedProperty

public ObjectProperty<Runnable> onPausedProperty()

Event handler invoked when the status changes to PAUSED.

Returns:

the onPaused property

See Also:

• getOnPaused()
• setOnPaused(Runnable)

setOnStopped

public final void setOnStopped(Runnable value)

Sets the MediaPlayer.Status.STOPPED event handler.

Parameters:

value - the event handler or null.

getOnStopped

public final Runnable getOnStopped()

Retrieves the MediaPlayer.Status.STOPPED event handler.

Returns:

the event handler or null.

onStoppedProperty

public ObjectProperty<Runnable> onStoppedProperty()

Event handler invoked when the status changes to STOPPED.

Returns:

the onStopped property

See Also:

• getOnStopped()
• setOnStopped(Runnable)

setOnHalted

public final void setOnHalted(Runnable value)

Sets the MediaPlayer.Status.HALTED event handler.

Parameters:

value - the event handler or null.

getOnHalted

public final Runnable getOnHalted()

Retrieves the MediaPlayer.Status.HALTED event handler.

Returns:

the event handler or null.

onHaltedProperty

public ObjectProperty<Runnable> onHaltedProperty()

Event handler invoked when the status changes to HALTED.

Returns:

the onHalted property

See Also:

• getOnHalted()
• setOnHalted(Runnable)

setOnRepeat

public final void setOnRepeat(Runnable value)

Sets the repeat event handler.

Parameters:

value - the event handler or null.

getOnRepeat

public final Runnable getOnRepeat()

Retrieves the repeat event handler.

Returns:

the event handler or null.

onRepeatProperty

public ObjectProperty<Runnable> onRepeatProperty()

Event handler invoked when the player currentTime reaches stopTime and will be repeating. This callback is made prior to seeking back to startTime.

Returns:

the onRepeat property

See Also:

• getOnRepeat()
• setOnRepeat(Runnable)

setOnStalled

public final void setOnStalled(Runnable value)

Sets the MediaPlayer.Status.STALLED event handler.

Parameters:

value - the event handler or null.

getOnStalled

public final Runnable getOnStalled()

Retrieves the MediaPlayer.Status.STALLED event handler.

Returns:

the event handler or null.

onStalledProperty

public ObjectProperty<Runnable> onStalledProperty()

Event handler invoked when the status changes to STALLED.

Returns:

the onStalled property

See Also:

• getOnStalled()
• setOnStalled(Runnable)

setStatus

public void setStatus(MediaPlayer.Status status)

Sets the value of the status property.

Property description:

Parameters:

status - the value for the status property

See Also:

• getStatus()
• statusProperty()