The Media class represents a media resource. It is instantiated from the string form of a source URI. Information about the media such as duration, metadata, tracks, and video resolution may be obtained from a Media instance. The media information is obtained asynchronously and so not necessarily available immediately after instantiation of the class. All information should however be available if the instance has been associated with a MediaPlayer and that player has transitioned to MediaPlayer.Status#READY status. To be notified when metadata or Tracks are added, observers may be registered with the collections returned by getMetadata()and getTracks(), respectively.

The same Media object may be shared among multiple MediaPlayer objects. Such a shared instance might manage a single copy of the source media data to be used by all players, or it might require a separate copy of the data for each player. The choice of implementation will not however have any effect on player behavior at the interface level.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	Media._MetadataListener
private class	Media.InitLocator

Field Summary

Modifier and Type	Field and Description
private ReadOnlyObjectWrapper<Duration>	duration The duration in seconds of the source media.
private ReadOnlyObjectWrapper<MediaException>	error A property set to a MediaException value when an error occurs.
private ReadOnlyIntegerWrapper	height The height in pixels of the source media.
private final Locator	jfxLocator Locator used by the jfxmedia player, MediaPlayer needs access to this
private MetadataParser	jfxParser
private ObservableMap<String, Duration>	markers The markers defined on this media source.
private ObservableMap<String, Object>	metadata An `ObservableMap` of metadata which can contain information about the media.
private final ObservableMap<String, Object>	metadataBacking
private MetadataListener	metadataListener
private ObjectProperty<Runnable>	onError Event handler called when an error occurs.
private final String	source The source URI of the media;
private ObservableList<Track>	tracks An `ObservableList` of tracks contained in this media object.
private final ObservableList<Track>	tracksBacking
private ReadOnlyIntegerWrapper	width The width in pixels of the source media.

Constructor Summary

Access	Constructor and Description
public	Media(String The URI of the source media. source) Constructs a `Media` instance.

Method Summary

Modifier and Type	Method and Description
pack-priv void	_setError(MediaException.Type type, String message)
pack-priv void	_updateMedia(Media _media)
public ReadOnlyObjectProperty<Duration>	durationProperty()
private ReadOnlyObjectWrapper<Duration>	durationPropertyImpl()
public ReadOnlyObjectProperty<MediaException>	errorProperty()
private ReadOnlyObjectWrapper<MediaException>	errorPropertyImpl()
public final Duration	Returns: the duration of the media, `Duration#UNKNOWN` if unknown or `Duration#INDEFINITE` for live streams getDuration() Retrieve the duration in seconds of the media.
public final MediaException	Returns: a `MediaException` or `null` if there is no error. getError() Return any error encountered in the media.
public final int	Returns: the media height or zero if the height is undefined or unknown. getHeight() Retrieve the height in pixels of the media.
public final ObservableMap<String, Duration>	Returns: the markers defined on this media source. getMarkers() Retrieve the markers defined on this `Media` instance.
public final ObservableMap<String, Object>	Returns: the metadata contained in this media source. getMetadata() Retrieve the metadata contained in this media source.
public final Runnable	Returns: the error handler or `null` if none is defined. getOnError() Retrieve the error handler to be called if an error occurs.
public String	Returns: the media source URI as a `String`. getSource() Retrieve the source URI of the media.
public final ObservableList<Track>	Returns: the tracks contained in this media source. getTracks() Retrieve the tracks contained in this media source.
private Track	getTrackWithID(long trackID)
public final int	Returns: the media width or zero if the width is undefined or unknown. getWidth() Retrieve the width in pixels of the media.
public ReadOnlyIntegerProperty	heightProperty()
private ReadOnlyIntegerWrapper	heightPropertyImpl()
public ObjectProperty<Runnable>	onErrorProperty()
pack-priv Locator	retrieveJfxLocator()
private void	runMetadataParser()
pack-priv final void	setDuration(Duration value)
private void	setError(MediaException value)
pack-priv final void	setHeight(int value)
public final void	setOnError(Runnable the error event handler. value) Set the event handler to be called when an error occurs.
pack-priv final void	setWidth(int value)
private synchronized void	updateMetadata(Map<String, Object> metadata)
public ReadOnlyIntegerProperty	widthProperty()
private ReadOnlyIntegerWrapper	widthPropertyImpl()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

duration	back to summary
private ReadOnlyObjectWrapper<Duration> duration The duration in seconds of the source media. If the media duration is unknown then this property value will be `Duration#UNKNOWN`.

error back to summary

error	back to summary
private ReadOnlyObjectWrapper<MediaException> error A property set to a MediaException value when an error occurs. If `error` is non-`null`, then the media could not be loaded and is not usable. If `onError` is non-`null`, it will be invoked when the `error` property is set. See Also `MediaException`

private ReadOnlyObjectWrapper<MediaException> error

A property set to a MediaException value when an error occurs. If error is non-null, then the media could not be loaded and is not usable. If onError is non-null, it will be invoked when the error property is set.

See Also: MediaException

height back to summary

height	back to summary
private ReadOnlyIntegerWrapper height The height in pixels of the source media. This may be zero if the media has no height, e.g., when playing audio, or if the height is currently unknown which may occur with streaming media. See Also `width`

private ReadOnlyIntegerWrapper height

The height in pixels of the source media. This may be zero if the media has no height, e.g., when playing audio, or if the height is currently unknown which may occur with streaming media.

See Also: width

jfxLocator	back to summary
private final Locator jfxLocator Locator used by the jfxmedia player, MediaPlayer needs access to this

jfxParser	back to summary
private MetadataParser jfxParser

markers	back to summary
private ObservableMap<String, Duration> markers The markers defined on this media source. A marker is defined to be a mapping from a name to a point in time between the beginning and end of the media.

metadata	back to summary
private ObservableMap<String, Object> metadata An `ObservableMap` of metadata which can contain information about the media. Metadata entries use `String`s for keys and contain `Object` values. This map is unmodifiable: its contents or stored values cannot be changed.

metadataBacking	back to summary
private final ObservableMap<String, Object> metadataBacking

metadataListener	back to summary
private MetadataListener metadataListener

onError	back to summary
private ObjectProperty<Runnable> onError Event handler called when an error occurs. This will happen if a malformed or invalid URL is passed to the constructor or there is a problem accessing the URL.

source	back to summary
private final String source The source URI of the media;

tracks back to summary

tracks	back to summary
private ObservableList<Track> tracks An `ObservableList` of tracks contained in this media object. A `Media` object can contain multiple tracks, such as a video track with several audio track. This list is unmodifiable: the contents cannot be changed. See Also `Track`

private ObservableList<Track> tracks

An ObservableList of tracks contained in this media object. A Media object can contain multiple tracks, such as a video track with several audio track. This list is unmodifiable: the contents cannot be changed.

See Also: Track

tracksBacking	back to summary
private final ObservableList<Track> tracksBacking

width back to summary

width	back to summary
private ReadOnlyIntegerWrapper width The width in pixels of the source media. This may be zero if the media has no width, e.g., when playing audio, or if the width is currently unknown which may occur with streaming media. See Also `height`

private ReadOnlyIntegerWrapper width

The width in pixels of the source media. This may be zero if the media has no width, e.g., when playing audio, or if the width is currently unknown which may occur with streaming media.

See Also: height

Constructor Detail

Media back to summary

Media	back to summary
public Media(String source) Constructs a `Media` instance. This is the only way to specify the media source. The source must represent a valid `URI` and is immutable. Only HTTP, HTTPS, FILE, and JAR `URL`s are supported. If the provided URL is invalid then an exception will be thrown. If an asynchronous error occurs, the `error` property will be set. Listen to this property to be notified of any such errors. If the source uses a non-blocking protocol such as FILE, then any problems which can be detected immediately will cause a `MediaException` to be thrown. Such problems include the media being inaccessible or in an unsupported format. If however a potentially blocking protocol such as HTTP is used, then the connection will be initialized asynchronously so that these sorts of errors will be signaled by setting the `error` property. Constraints: The supplied URI must conform to RFC-2396 as required by java.net.URI. Only HTTP, HTTPS, FILE, and JAR URIs are supported. See java.net.URI for more information about URI formatting in general. JAR URL syntax is specified in java.net.JarURLConnection. Parameters source:String The URI of the source media. Exceptions NullPointerException: if the URI string is `null`. IllegalArgumentException: if the URI string does not conform to RFC-2396 or, if appropriate, the Jar URL specification, or is in a non-compliant form which cannot be modified to a compliant form. if the URI string has a `null` scheme. UnsupportedOperationException: if the protocol specified for the source is not supported. MediaException: if the media source cannot be connected (type `MediaException.Type#MEDIA_INACCESSIBLE`) or is not supported (type `MediaException.Type#MEDIA_UNSUPPORTED`).

public Media(String source)

Constructs a Media instance. This is the only way to specify the media source. The source must represent a valid URI and is immutable. Only HTTP, HTTPS, FILE, and JAR URLs are supported. If the provided URL is invalid then an exception will be thrown. If an asynchronous error occurs, the error property will be set. Listen to this property to be notified of any such errors.

If the source uses a non-blocking protocol such as FILE, then any problems which can be detected immediately will cause a MediaException to be thrown. Such problems include the media being inaccessible or in an unsupported format. If however a potentially blocking protocol such as HTTP is used, then the connection will be initialized asynchronously so that these sorts of errors will be signaled by setting the error property.

Constraints:

The supplied URI must conform to RFC-2396 as required by java.net.URI.
Only HTTP, HTTPS, FILE, and JAR URIs are supported.

See java.net.URI for more information about URI formatting in general. JAR URL syntax is specified in java.net.JarURLConnection.

Parameters

source:String: The URI of the source media.

Exceptions

NullPointerException:

if the URI string is null.

IllegalArgumentException:

if the URI string does not conform to RFC-2396 or, if appropriate, the Jar URL specification, or is in a non-compliant form which cannot be modified to a compliant form.
if the URI string has a null scheme.

UnsupportedOperationException:

if the protocol specified for the source is not supported.

MediaException:

if the media source cannot be connected (type MediaException.Type#MEDIA_INACCESSIBLE) or is not supported (type MediaException.Type#MEDIA_UNSUPPORTED).

Method Detail

_setError	back to summary
pack-priv void _setError(MediaException.Type type, String message)

_updateMedia	back to summary
pack-priv void _updateMedia(Media _media)

durationProperty	back to summary
public ReadOnlyObjectProperty<Duration> durationProperty()

durationPropertyImpl	back to summary
private ReadOnlyObjectWrapper<Duration> durationPropertyImpl()

errorProperty	back to summary
public ReadOnlyObjectProperty<MediaException> errorProperty()

errorPropertyImpl	back to summary
private ReadOnlyObjectWrapper<MediaException> errorPropertyImpl()

getDuration back to summary

getDuration	back to summary
public final Duration getDuration() Retrieve the duration in seconds of the media. Returns:Duration the duration of the media, `Duration#UNKNOWN` if unknown or `Duration#INDEFINITE` for live streams

public final Duration getDuration()

Retrieve the duration in seconds of the media.

Returns:Duration: the duration of the media, Duration#UNKNOWN if unknown or Duration#INDEFINITE for live streams

getError back to summary

getError	back to summary
public final MediaException getError() Return any error encountered in the media. Returns:MediaException a `MediaException` or `null` if there is no error.

public final MediaException getError()

Return any error encountered in the media.

Returns:MediaException: a MediaException or null if there is no error.

getHeight	back to summary
public final int getHeight() Retrieve the height in pixels of the media. Returns:int the media height or zero if the height is undefined or unknown.

getHeight

back to summary

public final int getHeight()

Retrieve the height in pixels of the media.

Returns:int: the media height or zero if the height is undefined or unknown.

getMarkers back to summary

getMarkers	back to summary
public final ObservableMap<String, Duration> getMarkers() Retrieve the markers defined on this `Media` instance. If there are no markers the returned `ObservableMap` will be empty. Programmatic markers may be added by inserting entries in the returned `Map`. Returns:ObservableMap<String, Duration> the markers defined on this media source.

public final ObservableMap<String, Duration> getMarkers()

Retrieve the markers defined on this Media instance. If there are no markers the returned ObservableMap will be empty. Programmatic markers may be added by inserting entries in the returned Map.

Returns:ObservableMap<String, Duration>: the markers defined on this media source.

getMetadata back to summary

public final ObservableMap<String, Object> getMetadata()

Retrieve the metadata contained in this media source. If there are no metadata, the returned ObservableMap will be empty.

Returns:ObservableMap<String, Object>: the metadata contained in this media source.

getOnError back to summary

getOnError	back to summary
public final Runnable getOnError() Retrieve the error handler to be called if an error occurs. Returns:Runnable the error handler or `null` if none is defined.

public final Runnable getOnError()

Retrieve the error handler to be called if an error occurs.

Returns:Runnable: the error handler or null if none is defined.

getSource back to summary

getSource	back to summary
public String getSource() Retrieve the source URI of the media. Returns:String the media source URI as a `String`.

public String getSource()

Retrieve the source URI of the media.

Returns:String: the media source URI as a String.

getTracks back to summary

getTracks	back to summary
public final ObservableList<Track> getTracks() Retrieve the tracks contained in this media source. If there are no tracks, the returned `ObservableList` will be empty. Returns:ObservableList<Track> the tracks contained in this media source.

public final ObservableList<Track> getTracks()

Retrieve the tracks contained in this media source. If there are no tracks, the returned ObservableList will be empty.

Returns:ObservableList<Track>: the tracks contained in this media source.

getTrackWithID	back to summary
private Track getTrackWithID(long trackID)

getWidth	back to summary
public final int getWidth() Retrieve the width in pixels of the media. Returns:int the media width or zero if the width is undefined or unknown.

getWidth

back to summary

public final int getWidth()

Retrieve the width in pixels of the media.

Returns:int: the media width or zero if the width is undefined or unknown.

heightProperty	back to summary
public ReadOnlyIntegerProperty heightProperty()

heightPropertyImpl	back to summary
private ReadOnlyIntegerWrapper heightPropertyImpl()

onErrorProperty	back to summary
public ObjectProperty<Runnable> onErrorProperty()

retrieveJfxLocator	back to summary
pack-priv Locator retrieveJfxLocator()

runMetadataParser	back to summary
private void runMetadataParser()

setDuration	back to summary
pack-priv final void setDuration(Duration value)

setError	back to summary
private void setError(MediaException value)

setHeight	back to summary
pack-priv final void setHeight(int value)

setOnError	back to summary
public final void setOnError(Runnable value) Set the event handler to be called when an error occurs. Parameters value:Runnable the error event handler.

setOnError

back to summary

public final void setOnError(Runnable value)

Set the event handler to be called when an error occurs.

Parameters

value:Runnable: the error event handler.

setWidth	back to summary
pack-priv final void setWidth(int value)

updateMetadata	back to summary
private synchronized void updateMetadata(Map<String, Object> metadata)

widthProperty	back to summary
public ReadOnlyIntegerProperty widthProperty()

widthPropertyImpl	back to summary
private ReadOnlyIntegerWrapper widthPropertyImpl()

javafx.scene.media back to summary

private Class Media._MetadataListener

Class Inheritance

extends Object
implements MetadataListener

java.lang.Object
javafx.scene.media.Media._MetadataListener

All Implemented Interfaces

com.sun.media.jfxmedia.events.MetadataListener

Constructor Summary

Access	Constructor and Description
private	_MetadataListener()

Method Summary

Modifier and Type	Method and Description
public void	onMetadata(final Map<String, Object> metadata) Implements com.sun.media.jfxmedia.events.MetadataListener.onMetadata. The metadata notification indicates a metadata has been reached or metadata value was changed during playback.