Modifier and Type	Class and Description
private class	MediaView.MediaErrorInvalidationListener Inner class used to convert a `MediaPlayer` error into a `Bean` event.
private class	MediaView.MediaViewFrameTracker

Field Summary

Modifier and Type	Field and Description
private int	decodedFrameCount
private VideoFrameRateListener	decodedFrameRateListener Listener for decoded frame rate.
private static final String	DEFAULT_STYLE_CLASS
private InvalidationListener	errorListener Listener which converts `MediaPlayer` errors to events.
private DoubleProperty	fitHeight Determines the height of the bounding box within which the source media is resized as necessary to fit.
private DoubleProperty	fitWidth Determines the width of the bounding box within which the source media is resized as necessary to fit.
private InvalidationListener	mediaDimensionListener Listener which causes the geometry to be updated when the media dimension changes.
private ObjectProperty<MediaPlayer>	mediaPlayer The `mediaPlayer` whose output will be handled by this view.
private MediaPlayerOverlay	mediaPlayerOverlay
private ObjectProperty<EventHandler<MediaErrorEvent>>	onError Event handler to be invoked whenever an error occurs on this `MediaView`.
private ChangeListener<Number>	opacityListener
private ChangeListener<Parent>	parentListener
private BooleanProperty	preserveRatio Whether to preserve the aspect ratio (width / height) of the media when scaling it to fit the node.
private boolean	registerVideoFrameRateListener
private int	renderedFrameCount
private BooleanProperty	smooth If set to `true` a better quality filtering algorithm will be used when scaling this video to fit within the bounding box provided by `fitWidth` and `fitHeight` or when transforming.
private ChangeListener<Boolean>	treeVisibleListener
private static final String	VIDEO_FRAME_RATE_PROPERTY_NAME The name of the property in the `ObservableMap` returned by `getProperties()`.
private ObjectProperty<Rectangle2D>	viewport Specifies a rectangular viewport into the media frame.
private DoubleProperty	x Defines the current x coordinate of the `MediaView` origin.
private DoubleProperty	y Defines the current y coordinate of the `MediaView` origin.

Constructor Summary

Access	Constructor and Description
public	MediaView() Creates a `MediaView` instance with no associated `MediaPlayer`.
public	MediaView(MediaPlayer the `MediaPlayer` the playback of which is to be viewed via this class. mediaPlayer) Creates a `MediaView` instance associated with the specified `MediaPlayer`.

Method Summary

Modifier and Type	Method and Description
pack-priv void	_mediaPlayerOnReady() Called by MediaPlayer when it becomes ready
private static Affine3D	calculateNodeToSceneTransform(Node node)
private void	createListeners()
private VideoFrameRateListener	createVideoFrameRateListener() Creates a decoded frame rate listener.
private boolean	determineVisibility()
private boolean	doComputeContains(double localX, double localY)
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private NGNode	doCreatePeer()
private void	doTransformsChanged() Hides javafx.scene.Node.doTransformsChanged.
private void	doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.
public final DoubleProperty	fitHeightProperty()
public final DoubleProperty	fitWidthProperty()
public final double	Returns: the height of the resized media. getFitHeight() Retrieves the height of the bounding box of the resized media.
public final double	Returns: the height of the resized media. getFitWidth() Retrieves the width of the bounding box of the resized media.
public final MediaPlayer	Returns: the associated `MediaPlayer`. getMediaPlayer() Retrieves the `MediaPlayer` whose output is being handled by this view.
private MediaView	getMediaView() Returns: reference to MediaView
public final EventHandler<MediaErrorEvent>	Returns: the error event handler. getOnError() Retrieves the error event handler.
public final Rectangle2D	Returns: the rectangular viewport. getViewport() Retrieves the rectangular viewport into the media frame.
public final double	Returns: the x coordinate of the origin of the view. getX() Retrieves the x coordinate of the `MediaView` origin.
public final double	Returns: the y coordinate of the origin of the view. getY() Retrieves the y coordinate of the `MediaView` origin.
public final boolean	Returns: whether the media aspect ratio is preserved. isPreserveRatio() Returns whether the media aspect ratio is preserved when scaling.
public final boolean	Returns: whether to smooth the media isSmooth() Returns whether to smooth the media when scaling.
public final ObjectProperty<MediaPlayer>	mediaPlayerProperty()
pack-priv void	notifyMediaChange()
pack-priv void	notifyMediaFrameUpdated()
pack-priv void	notifyMediaSizeChange()
public final ObjectProperty<EventHandler<MediaErrorEvent>>	onErrorProperty()
pack-priv int	perfGetDecodedFrameCount() Returns: number of frames that have been submitted for rendering
pack-priv int	perfGetRenderedFrameCount() Returns: number of frames that have been rendered
pack-priv void	perfReset()
public final BooleanProperty	preserveRatioProperty()
public final void	setFitHeight(double the height of the resized media. value) Sets the height of the bounding box of the resized media.
public final void	setFitWidth(double the width of the resized media. value) Sets the width of the bounding box of the resized media.
public final void	setMediaPlayer(MediaPlayer the associated `MediaPlayer`. value) Sets the `MediaPlayer` whose output will be handled by this view.
public final void	setOnError(EventHandler<MediaErrorEvent> the error event handler. value) Sets the error event handler.
public final void	setPreserveRatio(boolean whether to preserve the media aspect ratio. value) Sets whether to preserve the media aspect ratio when scaling.
public final void	setSmooth(boolean whether to smooth the media. value) Sets whether to smooth the media when scaling.
public final void	setViewport(Rectangle2D the rectangular viewport. value) Sets the rectangular viewport into the media frame.
public final void	setX(double the x coordinate of the origin of the view. value) Sets the x coordinate of the `MediaView` origin.
public final void	setY(double the y coordinate of the origin of the view. value) Sets the y coordinate of the `MediaView` origin.
public final BooleanProperty	smoothProperty()
private void	updateMediaPlayerOverlay()
private synchronized void	updateOverlayHeight()
private synchronized void	updateOverlayOpacity()
private synchronized void	updateOverlayPreserveRatio()
private void	updateOverlayTransform()
private synchronized void	updateOverlayVisibility()
private synchronized void	updateOverlayWidth()
private synchronized void	updateOverlayX()
private synchronized void	updateOverlayY()
pack-priv void	updateViewport()
public final ObjectProperty<Rectangle2D>	viewportProperty()
public final DoubleProperty	xProperty()
public final DoubleProperty	yProperty()

Field Detail

decodedFrameCount	back to summary
private int decodedFrameCount

decodedFrameRateListener	back to summary
private VideoFrameRateListener decodedFrameRateListener Listener for decoded frame rate.

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

errorListener	back to summary
private InvalidationListener errorListener Listener which converts `MediaPlayer` errors to events.

fitHeight back to summary

fitHeight	back to summary
private DoubleProperty fitHeight Determines the height of the bounding box within which the source media is resized as necessary to fit. If `value ≤ 0`, then the height of the bounding box will be set to the natural height of the media, but `fitHeight` will be set to the supplied parameter, even if non-positive. See `preserveRatio` for information on interaction between media views `fitWidth`, `fitHeight` and `preserveRatio` attributes.

private DoubleProperty fitHeight

Determines the height of the bounding box within which the source media is resized as necessary to fit. If value ≤ 0, then the height of the bounding box will be set to the natural height of the media, but fitHeight will be set to the supplied parameter, even if non-positive.

See preserveRatio for information on interaction between media views fitWidth, fitHeight and preserveRatio attributes.

fitWidth back to summary

fitWidth	back to summary
private DoubleProperty fitWidth Determines the width of the bounding box within which the source media is resized as necessary to fit. If `value ≤ 0`, then the width of the bounding box will be set to the natural width of the media, but `fitWidth` will be set to the supplied parameter, even if non-positive. See `preserveRatio` for information on interaction between media views `fitWidth`, `fitHeight` and `preserveRatio` attributes.

private DoubleProperty fitWidth

Determines the width of the bounding box within which the source media is resized as necessary to fit. If value ≤ 0, then the width of the bounding box will be set to the natural width of the media, but fitWidth will be set to the supplied parameter, even if non-positive.

See preserveRatio for information on interaction between media views fitWidth, fitHeight and preserveRatio attributes.

mediaDimensionListener	back to summary
private InvalidationListener mediaDimensionListener Listener which causes the geometry to be updated when the media dimension changes.

mediaPlayer back to summary

mediaPlayer	back to summary
private ObjectProperty<MediaPlayer> mediaPlayer The `mediaPlayer` whose output will be handled by this view. Setting this value does not affect the status of the `MediaPlayer`, e.g., if the `MediaPlayer` was playing prior to setting `mediaPlayer` then it will continue playing. See Also `MediaException`, `MediaPlayer`

private ObjectProperty<MediaPlayer> mediaPlayer

The mediaPlayer whose output will be handled by this view. Setting this value does not affect the status of the MediaPlayer, e.g., if the MediaPlayer was playing prior to setting mediaPlayer then it will continue playing.

See Also: MediaException, MediaPlayer

mediaPlayerOverlay	back to summary
private MediaPlayerOverlay mediaPlayerOverlay

onError back to summary

onError	back to summary
private ObjectProperty<EventHandler<MediaErrorEvent>> onError Event handler to be invoked whenever an error occurs on this `MediaView`. See Also `MediaErrorEvent`

private ObjectProperty<EventHandler<MediaErrorEvent>> onError

Event handler to be invoked whenever an error occurs on this MediaView.

See Also: MediaErrorEvent

opacityListener	back to summary
private ChangeListener<Number> opacityListener

parentListener	back to summary
private ChangeListener<Parent> parentListener

preserveRatio	back to summary
private BooleanProperty preserveRatio Whether to preserve the aspect ratio (width / height) of the media when scaling it to fit the node. If the aspect ratio is not preserved, the media will be stretched or sheared in both dimensions to fit the dimensions of the node. The default value is `true`.

registerVideoFrameRateListener	back to summary
private boolean registerVideoFrameRateListener

renderedFrameCount	back to summary
private int renderedFrameCount

smooth	back to summary
private BooleanProperty smooth If set to `true` a better quality filtering algorithm will be used when scaling this video to fit within the bounding box provided by `fitWidth` and `fitHeight` or when transforming. If set to `false` a faster but lesser quality filtering will be used. The default value depends on platform configuration.

treeVisibleListener	back to summary
private ChangeListener<Boolean> treeVisibleListener

VIDEO_FRAME_RATE_PROPERTY_NAME	back to summary
private static final String VIDEO_FRAME_RATE_PROPERTY_NAME The name of the property in the `ObservableMap` returned by `getProperties()`. This value must also be defined as a JVM command line definition for the frame rate to be added to the properties.

viewport back to summary

viewport	back to summary
private ObjectProperty<Rectangle2D> viewport Specifies a rectangular viewport into the media frame. The viewport is a rectangle specified in the coordinates of the media frame. The resulting bounds prior to scaling will be the size of the viewport. The displayed image will include the intersection of the frame and the viewport. The viewport can exceed the size of the frame, but only the intersection will be displayed. Setting `viewport` to null will clear the viewport.

private ObjectProperty<Rectangle2D> viewport

Specifies a rectangular viewport into the media frame. The viewport is a rectangle specified in the coordinates of the media frame. The resulting bounds prior to scaling will be the size of the viewport. The displayed image will include the intersection of the frame and the viewport. The viewport can exceed the size of the frame, but only the intersection will be displayed. Setting viewport to null will clear the viewport.

x	back to summary
private DoubleProperty x Defines the current x coordinate of the `MediaView` origin.

y	back to summary
private DoubleProperty y Defines the current y coordinate of the `MediaView` origin.

Constructor Detail

MediaView	back to summary
public MediaView() Creates a `MediaView` instance with no associated `MediaPlayer`.

MediaView back to summary

MediaView	back to summary
public MediaView(MediaPlayer mediaPlayer) Creates a `MediaView` instance associated with the specified `MediaPlayer`. Equivalent to `MediaPlayer player; // initialization omitted MediaView view = new MediaView(); view.setMediaPlayer(player);` Parameters mediaPlayer:MediaPlayer the `MediaPlayer` the playback of which is to be viewed via this class.

public MediaView(MediaPlayer mediaPlayer)

Creates a MediaView instance associated with the specified MediaPlayer. Equivalent to


MediaPlayer player; // initialization omitted
MediaView view = new MediaView();
view.setMediaPlayer(player);

Parameters

mediaPlayer:MediaPlayer: the MediaPlayer the playback of which is to be viewed via this class.

Method Detail

_mediaPlayerOnReady	back to summary
pack-priv void _mediaPlayerOnReady() Called by MediaPlayer when it becomes ready

calculateNodeToSceneTransform	back to summary
private static Affine3D calculateNodeToSceneTransform(Node node)

createListeners	back to summary
private void createListeners()

createVideoFrameRateListener	back to summary
private VideoFrameRateListener createVideoFrameRateListener() Creates a decoded frame rate listener. Will return `null` if the security manager does not permit retrieve system properties or if VIDEO_FRAME_RATE_PROPERTY_NAME is not set to "true."

determineVisibility	back to summary
private boolean determineVisibility()

doComputeContains	back to summary
private boolean doComputeContains(double localX, double localY)

doComputeGeomBounds	back to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

doCreatePeer	back to summary
private NGNode doCreatePeer()

doTransformsChanged	back to summary
private void doTransformsChanged() Hides javafx.scene.Node.doTransformsChanged.

doUpdatePeer	back to summary
private void doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.

fitHeightProperty	back to summary
public final DoubleProperty fitHeightProperty()

fitWidthProperty	back to summary
public final DoubleProperty fitWidthProperty()

getFitHeight	back to summary
public final double getFitHeight() Retrieves the height of the bounding box of the resized media. Returns:double the height of the resized media.

getFitHeight

back to summary

public final double getFitHeight()

Retrieves the height of the bounding box of the resized media.

Returns:double: the height of the resized media.

getFitWidth	back to summary
public final double getFitWidth() Retrieves the width of the bounding box of the resized media. Returns:double the height of the resized media.

getFitWidth

back to summary

public final double getFitWidth()

Retrieves the width of the bounding box of the resized media.

Returns:double: the height of the resized media.

getMediaPlayer back to summary

getMediaPlayer	back to summary
public final MediaPlayer getMediaPlayer() Retrieves the `MediaPlayer` whose output is being handled by this view. Returns:MediaPlayer the associated `MediaPlayer`.

public final MediaPlayer getMediaPlayer()

Retrieves the MediaPlayer whose output is being handled by this view.

Returns:MediaPlayer: the associated MediaPlayer.

getMediaView	back to summary
private MediaView getMediaView() Returns:MediaView reference to MediaView

getOnError	back to summary
public final EventHandler<MediaErrorEvent> getOnError() Retrieves the error event handler. Returns:EventHandler<MediaErrorEvent> the error event handler.

getOnError

back to summary

public final EventHandler<MediaErrorEvent> getOnError()

Retrieves the error event handler.

Returns:EventHandler<MediaErrorEvent>: the error event handler.

getViewport	back to summary
public final Rectangle2D getViewport() Retrieves the rectangular viewport into the media frame. Returns:Rectangle2D the rectangular viewport.

getViewport

back to summary

public final Rectangle2D getViewport()

Retrieves the rectangular viewport into the media frame.

Returns:Rectangle2D: the rectangular viewport.

getX back to summary

getX	back to summary
public final double getX() Retrieves the x coordinate of the `MediaView` origin. Returns:double the x coordinate of the origin of the view.

public final double getX()

Retrieves the x coordinate of the MediaView origin.

Returns:double: the x coordinate of the origin of the view.

getY back to summary

getY	back to summary
public final double getY() Retrieves the y coordinate of the `MediaView` origin. Returns:double the y coordinate of the origin of the view.

public final double getY()

Retrieves the y coordinate of the MediaView origin.

Returns:double: the y coordinate of the origin of the view.

isPreserveRatio	back to summary
public final boolean isPreserveRatio() Returns whether the media aspect ratio is preserved when scaling. Returns:boolean whether the media aspect ratio is preserved.

isPreserveRatio

back to summary

public final boolean isPreserveRatio()

Returns whether the media aspect ratio is preserved when scaling.

Returns:boolean: whether the media aspect ratio is preserved.

isSmooth	back to summary
public final boolean isSmooth() Returns whether to smooth the media when scaling. Returns:boolean whether to smooth the media

isSmooth

back to summary

public final boolean isSmooth()

Returns whether to smooth the media when scaling.

Returns:boolean: whether to smooth the media

mediaPlayerProperty	back to summary
public final ObjectProperty<MediaPlayer> mediaPlayerProperty()

notifyMediaChange	back to summary
pack-priv void notifyMediaChange()

notifyMediaFrameUpdated	back to summary
pack-priv void notifyMediaFrameUpdated()

notifyMediaSizeChange	back to summary
pack-priv void notifyMediaSizeChange()

onErrorProperty	back to summary
public final ObjectProperty<EventHandler<MediaErrorEvent>> onErrorProperty()

perfGetDecodedFrameCount	back to summary
pack-priv int perfGetDecodedFrameCount() Returns:int number of frames that have been submitted for rendering

perfGetRenderedFrameCount	back to summary
pack-priv int perfGetRenderedFrameCount() Returns:int number of frames that have been rendered

perfReset	back to summary
pack-priv void perfReset()

preserveRatioProperty	back to summary
public final BooleanProperty preserveRatioProperty()

setFitHeight

back to summary

public final void setFitHeight(double value)

Sets the height of the bounding box of the resized media.

Parameters

value:double: the height of the resized media.

setFitWidth

back to summary

public final void setFitWidth(double value)

Sets the width of the bounding box of the resized media.

Parameters

value:double: the width of the resized media.

setMediaPlayer back to summary

public final void setMediaPlayer(MediaPlayer value)

Sets the MediaPlayer whose output will be handled by this view.

Parameters

value:MediaPlayer: the associated MediaPlayer.

setOnError

back to summary

public final void setOnError(EventHandler<MediaErrorEvent> value)

Sets the error event handler.

Parameters

value:EventHandler<MediaErrorEvent>: the error event handler.

setPreserveRatio

back to summary

public final void setPreserveRatio(boolean value)

Sets whether to preserve the media aspect ratio when scaling.

Parameters

value:boolean: whether to preserve the media aspect ratio.

setSmooth

back to summary

public final void setSmooth(boolean value)

Sets whether to smooth the media when scaling.

Parameters

value:boolean: whether to smooth the media.

setViewport

back to summary

public final void setViewport(Rectangle2D value)

Sets the rectangular viewport into the media frame.

Parameters

value:Rectangle2D: the rectangular viewport.

setX back to summary

public final void setX(double value)

Sets the x coordinate of the MediaView origin.

Parameters

value:double: the x coordinate of the origin of the view.

setY back to summary

public final void setY(double value)

Sets the y coordinate of the MediaView origin.

Parameters

value:double: the y coordinate of the origin of the view.

smoothProperty	back to summary
public final BooleanProperty smoothProperty()

updateMediaPlayerOverlay	back to summary
private void updateMediaPlayerOverlay()

updateOverlayHeight	back to summary
private synchronized void updateOverlayHeight()

updateOverlayOpacity	back to summary
private synchronized void updateOverlayOpacity()

updateOverlayPreserveRatio	back to summary
private synchronized void updateOverlayPreserveRatio()

updateOverlayTransform	back to summary
private void updateOverlayTransform()

updateOverlayVisibility	back to summary
private synchronized void updateOverlayVisibility()

updateOverlayWidth	back to summary
private synchronized void updateOverlayWidth()

updateOverlayX	back to summary
private synchronized void updateOverlayX()

updateOverlayY	back to summary
private synchronized void updateOverlayY()

updateViewport	back to summary
pack-priv void updateViewport()

viewportProperty	back to summary
public final ObjectProperty<Rectangle2D> viewportProperty()

xProperty	back to summary
public final DoubleProperty xProperty()

yProperty	back to summary
public final DoubleProperty yProperty()

javafx.scene.media back to summary

private Class MediaView.MediaErrorInvalidationListener

Class Inheritance

extends Object
implements InvalidationListener

java.lang.Object
javafx.scene.media.MediaView.MediaErrorInvalidationListener

All Implemented Interfaces

javafx.beans.InvalidationListener

Inner class used to convert a MediaPlayer error into a Bean event.

Constructor Summary

Access	Constructor and Description
private	MediaErrorInvalidationListener()

Method Summary

Modifier and Type	Method and Description
public void	invalidated(Observable value) Implements javafx.beans.InvalidationListener.invalidated. This method needs to be provided by an implementation of `InvalidationListener`.

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

Constructor Detail

MediaErrorInvalidationListener	back to summary
private MediaErrorInvalidationListener()

Method Detail

invalidated back to summary

public void invalidated(Observable value)

Implements javafx.beans.InvalidationListener.invalidated.

Doc from javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener. It is called if an Observable becomes invalid.

In general, it is considered bad practice to modify the observed value in this method.

Annotations

@Override

public Class MediaView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MediaView.MediaErrorInvalidationListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MediaView.MediaViewFrameTracker

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	incrementDecodedFrameCount(int count) Implements com.sun.javafx.sg.prism.MediaFrameTracker.incrementDecodedFrameCount.
public void	incrementRenderedFrameCount(int count) Implements com.sun.javafx.sg.prism.MediaFrameTracker.incrementRenderedFrameCount.