Provides the set of classes for integrating audio and video into Java FX Applications. The primary use for this package is media playback. There are three principal classes in the media package: Media, MediaPlayer, and MediaView.

Contents

1. Supported Media Types
2. Supported Protocols
3. Supported Metadata Tags
4. Playing Media in Java FX

Container	Tag (type String)	Type	Description
FXM, FLV	audio codec	java.lang.String	The encoder used for the audio track.
FXM, FLV	duration	javafx.util.Duration	The duration of the media.
FXM, FLV	video codec	java.lang.String	The encoder used for the video track.
FXM, FLV	width	java.lang.Integer	The width in pixels of the video track.
FXM, FLV	height	java.lang.Integer	The height in pixels of the video track.
FXM, FLV	framerate	java.lang.Double	The video frame rate in frames per second.
FXM, FLV	creationdate	java.lang.String	The date when the video was created.
FXM, FLV, MP3	raw metadata	Map<String,ByteBuffer>	The raw metadata according to the appropriate media specification. The key "ID3" maps to MP3 ID3v2 metadata and "FLV" to the FLV onMetadata marker content.
MP3	album artist	java.lang.String	The artist for the overall album, possibly "Various Artists" for compilations.
MP3	album	java.lang.String	The name of the album.
MP3	artist	java.lang.String	The artist of the track.
MP3	comment-N	java.lang.String	A comment where N is a 0-relative index. Comment format: ContentDescription[lng]=Comment
MP3	composer	java.lang.String	The composer of the track.
MP3	year	java.lang.Integer	The year the track was recorded.
MP3	disc count	java.lang.Integer	The number of discs in the album.
MP3	disc number	java.lang.Integer	The 1-relative index of the disc on which this track appears.
MP3	duration	javafx.util.Duration	The duration of the track.
MP3	genre	java.lang.String	The genre of the track, for example, "Classical," "Darkwave," or "Jazz."
MP3	image	javafx.scene.image.Image	The album cover.
MP3	title	java.lang.String	The name of the track.
MP3	track count	java.lang.Integer	The number of tracks on the album.
MP3	track number	java.lang.Integer	The 1-relative index of this track on the disc.

1. Create a javafx.scene.media.Media object for the desired media source.
2. Create a javafx.scene.media.MediaPlayer object from the Media object.
3. Create a javafx.scene.media.MediaView object.
4. Add the MediaPlayer to the MediaView .
5. Add the MediaView to the scene graph.
6. Invoke javafx.scene.media.MediaPlayer.play().

• One Media object may be shared among multiple MediaPlayer s.
• One MediaPlayer may be shared amoung multiple MediaView s.
• Media may be played directly by a MediaPlayer without creating a MediaView although a view is required for display.
• Instead of MediaPlayer.play() , MediaPlayer.setAutoPlay(true) may be used to request that playing start as soon as possible.
• MediaPlayer has several operational states defined by javafx.scene.media.MediaPlayer.Status.
• Audio-only media may instead be played using javafx.scene.media.AudioClip (recommended for low latency playback of short clips).

Error Handling

Errors using Java FX Media may be either synchronous or asynchronous. In general synchronous errors will manifest themselves as a Java Exception and asynchronous errors will cause a Java FX property to be set. In the latter case either the error property may be observed directly, an onError callback registered, or possibly both.

The main sources of synchronous errors are Media() and MediaPlayer(). The asynchronous error properties are Media.error and MediaPlayer.error, and the asynchronous error callbacks Media.onError, MediaPlayer.onError, and MediaView.onError.

Some errors might be duplicated. For example, a MediaPlayer will propagate an error that it encounters to its associated Media , and a MediaPlayer to all its associated MediaView s. As a consequence, it is possible to receive multiple notifications of the occurrence of a given error, depending on which properties are monitored.

The following code snippet illustrates error handling with media:

        String source;
    Media media;
    MediaPlayer mediaPlayer;
    MediaView mediaView;
    try {
        media = new Media(source);
        if (media.getError() == null) {
            media.setOnError(new Runnable() {
                public void run() {
                    // Handle asynchronous error in Media object.
                }
            });
            try {
                mediaPlayer = new MediaPlayer(media);
                if (mediaPlayer.getError() == null) {
                    mediaPlayer.setOnError(new Runnable() {
                        public void run() {
                            // Handle asynchronous error in MediaPlayer object.
                        }
                    });
                    mediaView = new MediaView(mediaPlayer);
                    mediaView.setOnError(new EventHandler
    () {
                        public void handle(MediaErrorEvent t) {
                            // Handle asynchronous error in MediaView.
                        }
                    });
                } else {
                    // Handle synchronous error creating MediaPlayer.
                }
            } catch (Exception mediaPlayerException) {
                // Handle exception in MediaPlayer constructor.
            }
        } else {
            // Handle synchronous error creating Media.
        }
    } catch (Exception mediaException) {
        // Handle exception in Media constructor.
    }