org.openstreetmap.josm.io.audio

Class JavaFxMediaPlayer

java.lang.Object

org.openstreetmap.josm.io.audio.JavaFxMediaPlayer

All Implemented Interfaces:

SoundPlayer

class JavaFxMediaPlayer
extends java.lang.Object
implements SoundPlayer

Default sound player based on the Java FX Media API. Used on platforms where Java FX is available. It supports the following audio codecs:

• MP3
• AIFF containing uncompressed PCM
• WAV containing uncompressed PCM
• MPEG-4 multimedia container with Advanced Audio Coding (AAC) audio

Since:

12328

Field Summary

Fields

Modifier and Type	Field and Description
private ListenerList<AudioListener>	listeners
private javafx.scene.media.MediaPlayer	mediaPlayer

Constructor Summary

Constructors

Constructor and Description
JavaFxMediaPlayer()

Method Summary

Modifier and Type	Method and Description
void	addAudioListener(AudioListener listener) Adds a listener that will be notified of audio playback events.
static void	initFxPlatform() Initializes the JavaFX platform runtime.
void	pause(AudioPlayer.Execute command, AudioPlayer.State stateChange, java.net.URL playingUrl) Ask player to pause the current playing media.
void	play(AudioPlayer.Execute command, AudioPlayer.State stateChange, java.net.URL playingUrl) Ask player to play a new media.
boolean	playing(AudioPlayer.Execute command) Method called when a media is being played.
double	position() Returns the media playback position, in seconds.
double	speed() Returns the media playback speed ratio.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

private final ListenerList<AudioListener> listeners

mediaPlayer

private javafx.scene.media.MediaPlayer mediaPlayer

Constructor Detail

JavaFxMediaPlayer

JavaFxMediaPlayer()
           throws JosmRuntimeException

Throws:

JosmRuntimeException

Method Detail

initFxPlatform

public static void initFxPlatform()
                           throws java.lang.InterruptedException

Initializes the JavaFX platform runtime.

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

play

public void play(AudioPlayer.Execute command,
                 AudioPlayer.State stateChange,
                 java.net.URL playingUrl)
          throws AudioException,
                 java.io.IOException

Description copied from interface: SoundPlayer

Ask player to play a new media.

Specified by:

play in interface SoundPlayer

Parameters:

command - Command containing media information

stateChange - the previous state

playingUrl - the currently playing URL, if any

Throws:

AudioException - if an audio error occurs

java.io.IOException - if an I/O error occurs

pause

public void pause(AudioPlayer.Execute command,
                  AudioPlayer.State stateChange,
                  java.net.URL playingUrl)
           throws AudioException,
                  java.io.IOException

Description copied from interface: SoundPlayer

Ask player to pause the current playing media.

Specified by:

pause in interface SoundPlayer

Parameters:

command - Command containing media information

stateChange - the previous state

playingUrl - the currently playing URL, if any

Throws:

AudioException - if an audio error occurs

java.io.IOException - if an I/O error occurs

playing

public boolean playing(AudioPlayer.Execute command)
                throws AudioException,
                       java.io.IOException,
                       java.lang.InterruptedException

Description copied from interface: SoundPlayer

Method called when a media is being played.

Specified by:

playing in interface SoundPlayer

Parameters:

command - Command containing media information

Returns:

true if the playing call was blocking, and the playback is finished when this method returns

Throws:

AudioException - if an audio error occurs

java.io.IOException - if an I/O error occurs

java.lang.InterruptedException - if the play is interrupted

position

public double position()

Description copied from interface: SoundPlayer

Returns the media playback position, in seconds.

Specified by:

position in interface SoundPlayer

Returns:

the media playback position, in seconds

speed

public double speed()

Description copied from interface: SoundPlayer

Returns the media playback speed ratio.

Specified by:

speed in interface SoundPlayer

Returns:

the media playback speed ratio

addAudioListener

public void addAudioListener(AudioListener listener)

Description copied from interface: SoundPlayer

Adds a listener that will be notified of audio playback events.

Specified by:

addAudioListener in interface SoundPlayer

Parameters:

listener - audio listener