com.sun.media.jfxmediaimpl

Class NativeMediaPlayer

java.lang.Object

com.sun.media.jfxmediaimpl.NativeMediaPlayer

All Implemented Interfaces:

MediaPlayer, MarkerStateListener

Direct Known Subclasses:

IOSMediaPlayer

public abstract class NativeMediaPlayer
extends Object
implements MediaPlayer, MarkerStateListener

Base implementation of a MediaPlayer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NativeMediaPlayer.MediaErrorEvent Event to be posted to any registered (@link MediaErrorListener)s

Field Summary

Fields

Modifier and Type	Field and Description
static int	eventPlayerError
static int	eventPlayerFinished
static int	eventPlayerPaused
static int	eventPlayerPlaying
static int	eventPlayerReady
static int	eventPlayerStalled
static int	eventPlayerStopped
static int	eventPlayerUnknown
static long	ONE_SECOND

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NativeMediaPlayer(NativeMedia clip) Construct a NativeMediaPlayer for the referenced clip.

Method Summary

Modifier and Type	Method and Description
void	addAudioSpectrumListener(AudioSpectrumListener listener) Adds a listener for audio spectrum events.
void	addBufferListener(BufferListener listener) Adds a listener for all buffer events.
void	addMarkerListener(MarkerListener listener) Adds a listener for marker events.
void	addMediaErrorListener(MediaErrorListener listener) Adds a listener for warnings which occur within the lifespan of the player.
void	addMediaPlayerListener(PlayerStateListener listener) Adds a listener for media state.
void	addMediaTimeListener(PlayerTimeListener listener) Adds a listener for player time events.
void	addVideoTrackSizeListener(VideoTrackSizeListener listener) Adds a listener for video track frame dimensions.
protected AudioEqualizer	createNativeAudioEqualizer(long nativeRef)
protected AudioSpectrum	createNativeAudioSpectrum(long nativeRef)
void	dispose() Release any resources held by this player.
abstract AudioSpectrum	getAudioSpectrum() Gets the audio spectrum controller for the player.
long	getAudioSyncDelay() Retrieve the audio rendering delay.
float	getBalance() Gets the current balance.
double	getDuration() Gets the duration in seconds.
abstract AudioEqualizer	getEqualizer() Gets the master audio equalizer for the player.
Media	getMedia() Gets a Media object.
boolean	getMute() Gets the muted state.
double	getPresentationTime() Gets the current presentation time.
float	getRate() Get the rate of playback.
double	getStartTime() Gets the time within the duration of the media to start playing.
PlayerStateEvent.PlayerState	getState() Retrieves the current state of the player.
double	getStopTime() Gets the time within the duration of the media to stop playing.
VideoRenderControl	getVideoRenderControl() Returns the video rendering support interface.
float	getVolume() Gets the current volume.
protected void	init() Initialization method which must be called after construction to initialize the internal state of the player.
void	markerStateChanged(boolean hasMarkers)
void	pause() Pauses the media playing.
void	play() Begins playing of the media.
protected abstract void	playerDispose()
protected abstract void	playerFinish()
protected abstract long	playerGetAudioSyncDelay()
protected abstract float	playerGetBalance()
protected abstract double	playerGetDuration()
protected abstract boolean	playerGetMute()
protected abstract double	playerGetPresentationTime()
protected abstract float	playerGetRate()
protected abstract float	playerGetVolume()
protected abstract void	playerInit()
protected abstract void	playerPause()
protected abstract void	playerPlay()
protected abstract void	playerSeek(double streamTime)
protected abstract void	playerSetAudioSyncDelay(long delay)
protected abstract void	playerSetBalance(float balance)
protected abstract void	playerSetMute(boolean state)
protected abstract void	playerSetRate(float rate)
protected abstract void	playerSetVolume(float volume)
protected abstract void	playerStop()
void	removeAudioSpectrumListener(AudioSpectrumListener listener) Removes a listener for audio spectrum events.
void	removeBufferListener(BufferListener listener) Removes a listener for buffer events.
void	removeMarkerListener(MarkerListener listener) Removes a listener for marker events.
void	removeMediaErrorListener(MediaErrorListener listener) Removes a listener for warnings.
void	removeMediaPlayerListener(PlayerStateListener listener) Removes a listener for media state.
void	removeMediaTimeListener(PlayerTimeListener listener) Removes a listener for player time events.
void	removeVideoTrackSizeListener(VideoTrackSizeListener listener) Removes a listener for video track frame dimensions.
void	seek(double streamTime) Seeks playback to the specified time.
protected void	sendAudioSpectrumEvent(double timestamp, double duration)
protected void	sendAudioTrack(boolean enabled, long trackID, String name, int encoding, String language, int numChannels, int channelMask, float sampleRate)
protected void	sendBufferProgressEvent(double clipDuration, long bufferStart, long bufferStop, long bufferPosition)
protected void	sendDurationUpdateEvent(double duration)
protected void	sendFrameSizeChangedEvent(int width, int height)
protected void	sendMarkerEvent(String name, double time)
protected void	sendNewFrameEvent(long nativeRef)
protected void	sendPlayerEvent(PlayerEvent evt)
protected void	sendPlayerHaltEvent(String message, double time)
protected void	sendPlayerMediaErrorEvent(int errorCode)
protected void	sendPlayerStateEvent(int eventID, double time)
protected void	sendSubtitleTrack(boolean enabled, long trackID, String name, int encoding, String language)
protected void	sendVideoTrack(boolean enabled, long trackID, String name, int encoding, int width, int height, float frameRate, boolean hasAlphaChannel)
protected void	sendWarning(int warningCode, String warningMessage)
void	setAudioSyncDelay(long delay) Set the amount of time to delay the audio.
void	setBalance(float bal) Sets the balance.
void	setMute(boolean enable) Enables/disable mute.
void	setRate(float rate) Sets the rate of playback.
void	setStartTime(double startTime) Sets the start time within the media to play.
void	setStopTime(double stopTime) Sets the stop time within the media to stop playback.
void	setVolume(float vol) Sets the volume.
void	stop() Stops playing of the media and resets the play time to 0.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.media.jfxmedia.MediaPlayer

getMediaPlayerOverlay

Field Detail

eventPlayerUnknown

@Native
public static final int eventPlayerUnknown

See Also:

Constant Field Values

eventPlayerReady

@Native
public static final int eventPlayerReady

See Also:

Constant Field Values

eventPlayerPlaying

@Native
public static final int eventPlayerPlaying

See Also:

Constant Field Values

eventPlayerPaused

@Native
public static final int eventPlayerPaused

See Also:

Constant Field Values

eventPlayerStopped

@Native
public static final int eventPlayerStopped

See Also:

Constant Field Values

eventPlayerStalled

@Native
public static final int eventPlayerStalled

See Also:

Constant Field Values

eventPlayerFinished

@Native
public static final int eventPlayerFinished

See Also:

Constant Field Values

eventPlayerError

@Native
public static final int eventPlayerError

See Also:

Constant Field Values

ONE_SECOND

@Native
public static final long ONE_SECOND

See Also:

Constant Field Values

Constructor Detail

NativeMediaPlayer

protected NativeMediaPlayer(NativeMedia clip)

Construct a NativeMediaPlayer for the referenced clip.

Parameters:

clip - Media object

Throws:

IllegalArgumentException - if clip is null.

Method Detail

init

protected void init()

Initialization method which must be called after construction to initialize the internal state of the player. This method should be invoked directly after the player is constructed.

addMediaErrorListener

public void addMediaErrorListener(MediaErrorListener listener)

Description copied from interface: MediaPlayer

Adds a listener for warnings which occur within the lifespan of the player.

Specified by:

addMediaErrorListener in interface MediaPlayer

Parameters:

listener - The warning listener.

removeMediaErrorListener

public void removeMediaErrorListener(MediaErrorListener listener)

Description copied from interface: MediaPlayer

Removes a listener for warnings.

Specified by:

removeMediaErrorListener in interface MediaPlayer

Parameters:

listener - The warning listener.

addMediaPlayerListener

public void addMediaPlayerListener(PlayerStateListener listener)

Description copied from interface: MediaPlayer

Adds a listener for media state.

Specified by:

addMediaPlayerListener in interface MediaPlayer

removeMediaPlayerListener

public void removeMediaPlayerListener(PlayerStateListener listener)

Description copied from interface: MediaPlayer

Removes a listener for media state.

Specified by:

removeMediaPlayerListener in interface MediaPlayer

addMediaTimeListener

public void addMediaTimeListener(PlayerTimeListener listener)

Description copied from interface: MediaPlayer

Adds a listener for player time events.

Specified by:

addMediaTimeListener in interface MediaPlayer

removeMediaTimeListener

public void removeMediaTimeListener(PlayerTimeListener listener)

Description copied from interface: MediaPlayer

Removes a listener for player time events.

Specified by:

removeMediaTimeListener in interface MediaPlayer

addVideoTrackSizeListener

public void addVideoTrackSizeListener(VideoTrackSizeListener listener)

Description copied from interface: MediaPlayer

Adds a listener for video track frame dimensions.

Specified by:

addVideoTrackSizeListener in interface MediaPlayer

removeVideoTrackSizeListener

public void removeVideoTrackSizeListener(VideoTrackSizeListener listener)

Description copied from interface: MediaPlayer

Removes a listener for video track frame dimensions.

Specified by:

removeVideoTrackSizeListener in interface MediaPlayer

addMarkerListener

public void addMarkerListener(MarkerListener listener)

Description copied from interface: MediaPlayer

Adds a listener for marker events.

Specified by:

addMarkerListener in interface MediaPlayer

removeMarkerListener

public void removeMarkerListener(MarkerListener listener)

Description copied from interface: MediaPlayer

Removes a listener for marker events.

Specified by:

removeMarkerListener in interface MediaPlayer

addBufferListener

public void addBufferListener(BufferListener listener)

Description copied from interface: MediaPlayer

Adds a listener for all buffer events.

Specified by:

addBufferListener in interface MediaPlayer

removeBufferListener

public void removeBufferListener(BufferListener listener)

Description copied from interface: MediaPlayer

Removes a listener for buffer events.

Specified by:

removeBufferListener in interface MediaPlayer

addAudioSpectrumListener

public void addAudioSpectrumListener(AudioSpectrumListener listener)

Description copied from interface: MediaPlayer

Adds a listener for audio spectrum events.

Specified by:

addAudioSpectrumListener in interface MediaPlayer

removeAudioSpectrumListener

public void removeAudioSpectrumListener(AudioSpectrumListener listener)

Description copied from interface: MediaPlayer

Removes a listener for audio spectrum events.

Specified by:

removeAudioSpectrumListener in interface MediaPlayer

getVideoRenderControl

public VideoRenderControl getVideoRenderControl()

Description copied from interface: MediaPlayer

Returns the video rendering support interface.

Specified by:

getVideoRenderControl in interface MediaPlayer

Returns:

A VideoRenderControl instance.

getMedia

public Media getMedia()

Description copied from interface: MediaPlayer

Gets a Media object.

Specified by:

getMedia in interface MediaPlayer

Returns:

Media object.

setAudioSyncDelay

public void setAudioSyncDelay(long delay)

Description copied from interface: MediaPlayer

Set the amount of time to delay the audio. A positive value makes audio render later, and a negative value makes audio render earlier.

Specified by:

setAudioSyncDelay in interface MediaPlayer

Parameters:

delay - time in milliseconds

getAudioSyncDelay

public long getAudioSyncDelay()

Description copied from interface: MediaPlayer

Retrieve the audio rendering delay.

Specified by:

getAudioSyncDelay in interface MediaPlayer

play

public void play()

Description copied from interface: MediaPlayer

Begins playing of the media. To ensure smooth playback, catch the onReady event in the MediaPlayerListener before playing.

Specified by:

play in interface MediaPlayer

stop

public void stop()

Description copied from interface: MediaPlayer

Stops playing of the media and resets the play time to 0.

Specified by:

stop in interface MediaPlayer

pause

public void pause()

Description copied from interface: MediaPlayer

Pauses the media playing. Calling play() after pause() will continue playing the media from where it left off.

Specified by:

pause in interface MediaPlayer

getRate

public float getRate()

Description copied from interface: MediaPlayer

Get the rate of playback.

Specified by:

getRate in interface MediaPlayer

setRate

public void setRate(float rate)

Description copied from interface: MediaPlayer

Sets the rate of playback. A positive value indicates forward play and a negative value reverse play.

Specified by:

setRate in interface MediaPlayer

getPresentationTime

public double getPresentationTime()

Description copied from interface: MediaPlayer

Gets the current presentation time. If the time is unknown or cannot be obtained when this method is invoked, a negative value will be returned.

Specified by:

getPresentationTime in interface MediaPlayer

Returns:

the current presentation time

getVolume

public float getVolume()

Description copied from interface: MediaPlayer

Gets the current volume.

Specified by:

getVolume in interface MediaPlayer

Returns:

the current volume

setVolume

public void setVolume(float vol)

Description copied from interface: MediaPlayer

Sets the volume. Values will be clamped to the range [0, 1.0].

Specified by:

setVolume in interface MediaPlayer

Parameters:

vol - A value in the range [0, 1.0].

getMute

public boolean getMute()

Description copied from interface: MediaPlayer

Gets the muted state. While muted no audio will be heard.

Specified by:

getMute in interface MediaPlayer

Returns:

true if audio is muted.

setMute

public void setMute(boolean enable)

Enables/disable mute. If mute is enabled then disabled, the previous volume goes into effect.

Specified by:

setMute in interface MediaPlayer

getBalance

public float getBalance()

Description copied from interface: MediaPlayer

Gets the current balance.

Specified by:

getBalance in interface MediaPlayer

Returns:

the current balance

setBalance

public void setBalance(float bal)

Description copied from interface: MediaPlayer

Sets the balance. A negative value indicates left of center and a positive value right of center. Values will be clamped to the range [-1.0, 1.0].

Specified by:

setBalance in interface MediaPlayer

Parameters:

bal - A value in the range [-1.0, 1.0].

getEqualizer

public abstract AudioEqualizer getEqualizer()

Description copied from interface: MediaPlayer

Gets the master audio equalizer for the player.

Specified by:

getEqualizer in interface MediaPlayer

Returns:

AudioEqualizer object

getAudioSpectrum

public abstract AudioSpectrum getAudioSpectrum()

Description copied from interface: MediaPlayer

Gets the audio spectrum controller for the player.

Specified by:

getAudioSpectrum in interface MediaPlayer

Returns:

AudioSpectrum object

getDuration

public double getDuration()

Description copied from interface: MediaPlayer

Gets the duration in seconds. If the duration is unknown or cannot be obtained when this method is invoked, a negative value will be returned.

Specified by:

getDuration in interface MediaPlayer

getStartTime

public double getStartTime()

Gets the time within the duration of the media to start playing.

Specified by:

getStartTime in interface MediaPlayer

setStartTime

public void setStartTime(double startTime)

Sets the start time within the media to play.

Specified by:

setStartTime in interface MediaPlayer

getStopTime

public double getStopTime()

Gets the time within the duration of the media to stop playing.

Specified by:

getStopTime in interface MediaPlayer

setStopTime

public void setStopTime(double stopTime)

Sets the stop time within the media to stop playback.

Specified by:

setStopTime in interface MediaPlayer

seek

public void seek(double streamTime)

Description copied from interface: MediaPlayer

Seeks playback to the specified time. The state of the player is unchanged. A negative value will be clamped to zero, and a positive value to the duration, if known.

Specified by:

seek in interface MediaPlayer

Parameters:

streamTime - The time in seconds to which to seek.

playerGetAudioSyncDelay

protected abstract long playerGetAudioSyncDelay()
                                         throws MediaException

Throws:

MediaException

playerSetAudioSyncDelay

protected abstract void playerSetAudioSyncDelay(long delay)
                                         throws MediaException

Throws:

MediaException

playerPlay

protected abstract void playerPlay()
                            throws MediaException

Throws:

MediaException

playerStop

protected abstract void playerStop()
                            throws MediaException

Throws:

MediaException

playerPause

protected abstract void playerPause()
                             throws MediaException

Throws:

MediaException

playerFinish

protected abstract void playerFinish()
                              throws MediaException

Throws:

MediaException

playerGetRate

protected abstract float playerGetRate()
                                throws MediaException

Throws:

MediaException

playerSetRate

protected abstract void playerSetRate(float rate)
                               throws MediaException

Throws:

MediaException

playerGetPresentationTime

protected abstract double playerGetPresentationTime()
                                             throws MediaException

Throws:

MediaException

playerGetMute

protected abstract boolean playerGetMute()
                                  throws MediaException

Throws:

MediaException

playerSetMute

protected abstract void playerSetMute(boolean state)
                               throws MediaException

Throws:

MediaException

playerGetVolume

protected abstract float playerGetVolume()
                                  throws MediaException

Throws:

MediaException

playerSetVolume

protected abstract void playerSetVolume(float volume)
                                 throws MediaException

Throws:

MediaException

playerGetBalance

protected abstract float playerGetBalance()
                                   throws MediaException

Throws:

MediaException

playerSetBalance

protected abstract void playerSetBalance(float balance)
                                  throws MediaException

Throws:

MediaException

playerGetDuration

protected abstract double playerGetDuration()
                                     throws MediaException

Throws:

MediaException

playerSeek

protected abstract void playerSeek(double streamTime)
                            throws MediaException

Throws:

MediaException

playerInit

protected abstract void playerInit()
                            throws MediaException

Throws:

MediaException

playerDispose

protected abstract void playerDispose()

getState

public PlayerStateEvent.PlayerState getState()

Retrieves the current state of the player.

Specified by:

getState in interface MediaPlayer

Returns:

the current player state.

dispose

public final void dispose()

Description copied from interface: MediaPlayer

Release any resources held by this player. The player will be unusable after this method is invoked.

Specified by:

dispose in interface MediaPlayer

sendWarning

protected void sendWarning(int warningCode,
                           String warningMessage)

sendPlayerEvent

protected void sendPlayerEvent(PlayerEvent evt)

sendPlayerHaltEvent

protected void sendPlayerHaltEvent(String message,
                                   double time)

sendPlayerMediaErrorEvent

protected void sendPlayerMediaErrorEvent(int errorCode)

sendPlayerStateEvent

protected void sendPlayerStateEvent(int eventID,
                                    double time)

sendNewFrameEvent

protected void sendNewFrameEvent(long nativeRef)

sendFrameSizeChangedEvent

protected void sendFrameSizeChangedEvent(int width,
                                         int height)

sendAudioTrack

protected void sendAudioTrack(boolean enabled,
                              long trackID,
                              String name,
                              int encoding,
                              String language,
                              int numChannels,
                              int channelMask,
                              float sampleRate)

sendVideoTrack

protected void sendVideoTrack(boolean enabled,
                              long trackID,
                              String name,
                              int encoding,
                              int width,
                              int height,
                              float frameRate,
                              boolean hasAlphaChannel)

sendSubtitleTrack

protected void sendSubtitleTrack(boolean enabled,
                                 long trackID,
                                 String name,
                                 int encoding,
                                 String language)

sendMarkerEvent

protected void sendMarkerEvent(String name,
                               double time)

sendDurationUpdateEvent

protected void sendDurationUpdateEvent(double duration)

sendBufferProgressEvent

protected void sendBufferProgressEvent(double clipDuration,
                                       long bufferStart,
                                       long bufferStop,
                                       long bufferPosition)

sendAudioSpectrumEvent

protected void sendAudioSpectrumEvent(double timestamp,
                                      double duration)

markerStateChanged

public void markerStateChanged(boolean hasMarkers)

Specified by:

markerStateChanged in interface MarkerStateListener

createNativeAudioEqualizer

protected AudioEqualizer createNativeAudioEqualizer(long nativeRef)

createNativeAudioSpectrum

protected AudioSpectrum createNativeAudioSpectrum(long nativeRef)