public class javafx.scene.media.MediaPlayer

Inherits from: com.sun.javafx.runtime.FXBase > javafx.scene.media.MediaPlayer

Known subclasses:

Jump to Section:
overview
variables
functions

Overview

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 playing. Note that the MediaPlayer does not contain any visual elements so must be used with the MediaView class to view the media. The number of MediaPlayers that can concurrently display media may vary depending on the JavaFX runtime implementation.

See Also:
Media, MediaView

Profile: common

Script Variable Summary

access	name	type	description
public	BUFFERING	Integer	This state is unimplemented and may be deprecated in future releases.
public-read	PAUSED	Integer	Value of status when playback is stopped or paused.
public	PLAYING	Integer	Value of status while the player is playing the media.
public	REPEAT_FOREVER	Integer	When repeatCount is set to this value, the player will repeat playback of the `Media` until stopped.
public	REPEAT_NONE	Number	When repeatCount is set to this value, the player will play the `Media` only once.
public	STALLED	Integer	This state is unimplemented and may be deprecated in future releases.

Variable Summary

access	name	type	description
public	autoPlay	Boolean	If `autoPlay` is `true`, playing will start as soon as possible
public	balance	Number	Defines the balance, or left/right setting, of the audio output. Defines the balance, or left/right setting, of the audio output. Value ranges continuously from `-1.0` being full left, `0.0` being center, and `1.0` being full right. Profile: common
public-read	bufferProgressTime	Duration	For a bufferred stream, the current buffer position which indicates how much media can be played without stalling the `MediaPlayer`. For a bufferred stream, the current buffer position which indicates how much media can be played without stalling the `MediaPlayer`. Setting currentTime to a value beyond `bufferProgressTime` is undefined and behavior may be implementation dependent. This issue will be resolved in a future release. Profile: common
public-read	currentCount	Number	Defines the current number of times the media has repeated. Defines the current number of times the media has repeated. This property is incremented just prior to seeking back to startTime. Profile: common
public	currentTime	Duration	The current media time, may be read to indicate the current position or written to cause the media to seek to the set position. The current media time, may be read to indicate the current position or written to cause the media to seek to the set position. Note that since the variable is being updated by the JavaFX rutime, `bind with inverse` must be used if it is being bound from another variable. Note that setting `currentTime` to a value outside of the range defined by startTime and stopTime will reset `currentTime` to startTime. Profile: common
public	enabledTracks	Track[]	The sequence of tracks that are currently enabled on this `MediaPlayer`. The sequence of tracks that are currently enabled on this `MediaPlayer`. To enable or disable tracks, a Track is respectively added or removed from this sequence. See Also: Media.tracks
public	fader	Number	The fader, or forward and back setting, of audio output on 4+ channel output. The fader, or forward and back setting, of audio output on 4+ channel output. Value ranges continuously from `-1.0` being rear, `0.0` being center, and `1.0` being forward. NOTE: This property is not implemented yet. Profile: common
public	media	Media	Defines the source Media to be played
public	mute	Boolean	When `true` the player's audio is muted, `false` otherwise.
public	onBuffering	function(:Duration):Void	This property is unimplemented and may be deprecated in future releases.
public	onEndOfMedia	function():Void	Invoked when the player `currentTime` reaches `stopTime` and is not repeating.
public	onError	function(:MediaError):Void	The `onError` function is called when a MediaError occurs on this player. The `onError` function is called when a MediaError occurs on this player. Note that `onError` should be intitialized before other variables so that errors can be handled properly. See Also: MediaError Profile: common
public	onRepeat	function():Void	Invoked when the player reaches `stopTime` and will be repeating. Invoked when the player reaches `stopTime` and will be repeating. This callback is made prior to seeking back to `startTime` See Also: repeatCount Profile: common
public	onStalled	function(:Duration):Void	This property is unimplemented and may be deprecated in future releases.
public	paused	Boolean	Indicates if the player has been paused, either programatically, by the user, or because the media has finished playing.
public	rate	Number	Defines the rate at which the media is being played. Defines the rate at which the media is being played. Rate `1.0` plays at the media's normal playback rate, `2.0` plays back at 2 times the normal rate, `-1.0` plays at the normal rate in reverse. Note that all not media formats support playing backwards or at arbitrary rates. Profile: common
public	repeatCount	Number	Defines the number of times the media should be played. Defines the number of times the media should be played. If `repeatCount` is 1 or REPEAT_NONE the media will play once then stop. If set to REPEAT_FOREVER, it will repeat indefinitely until manually stopped. Profile: common
public	startTime	Duration	Defines the time offset where media should start playing, or restart from when repeating. Defines 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. Constraints: `0 <= startTime < stopTime` Profile: common
public	status	Integer	Reflects the current status of the MediaPlayer. Reflects the current status of the MediaPlayer. The status is one of: PAUSED: The player has been paused or stopped PLAYING: The player is playing BUFFERING and STALLED are currently unimplemented and may be deprecated in future releases. Profile: common
public	stopTime	Duration	Defines the time offset where media should stop playing or restart when repeating
public-read	supportsMultiViews	Boolean	Indicates if this player can have multiple views associated with it.
public	timers	MediaTimer[]	The sequence of media timers for this player. The sequence of media timers for this player. For each MediaTimer in this sequence, its action function will be invoked when the time is reached by this `MediaPlayer` See Also: MediaTimer Profile: common
public	volume	Number	Defines the volume at which the media is being played. Defines the volume at which the media is being played. `1.0` is full volume, which is the default. A value of `0.0` effectively mutes the audio. Profile: common

Inherited Variables

Function Summary

public pause() : Void: Pauses the player.

Pauses the player.

Profile: common
public play() : Void: Starts playing the media.

Starts playing the media. If previously paused, then playback resumes where it was paused.

Profile: common
public stop() : Void: Stop playing the media.

Stop playing the media. This operation resets playback to startTime, and resets currentCount to zero.

Profile: common

Profile: desktop, common