com.bramosystems.oss.player.core.client.ui

Class NativePlayer

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.bramosystems.oss.player.core.client.AbstractMediaPlayer

com.bramosystems.oss.player.core.client.ui.NativePlayer

All Implemented Interfaces:

com.bramosystems.oss.player.core.client.PlaylistSupport, com.bramosystems.oss.player.core.event.client.HasMediaMessageHandlers, com.bramosystems.oss.player.core.event.client.HasMediaProgressHandlers, com.bramosystems.oss.player.core.event.client.HasMediaStateHandlers, com.bramosystems.oss.player.core.event.client.HasPlayStateHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class NativePlayer
extends com.bramosystems.oss.player.core.client.AbstractMediaPlayer
implements com.bramosystems.oss.player.core.client.PlaylistSupport

Widget to embed media files with HTML 5 video elements in compliant browsers.

Usage Example

 SimplePanel panel = new SimplePanel();   // create panel to hold the player
 Widget player = null;
 try {
      // create the player
      player = new NativePlayer("www.example.com/mediafile.ogg");
 } catch(PluginNotFoundException e) {
      // PluginNotFoundException thrown if browser does not support HTML 5 specs.
      player = PlayerUtil.getMissingPluginNotice(e.getPlugin());
 }

 panel.setWidget(player); // add player to panel.
 

Author:

Sikirulai Braheem

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
NativePlayer(ArrayList<String> mediaSources, boolean autoplay, String height, String width) Constructs NativePlayer with the specified height and width to playback media located at any of the mediaSources.
NativePlayer(String mediaURL) Constructs NativePlayer to playback media located at mediaURL.
NativePlayer(String mediaURL, boolean autoplay) Constructs NativePlayer to playback media located at mediaURL.
NativePlayer(String mediaURL, boolean autoplay, String height, String width) Constructs NativePlayer with the specified height and width to playback media located at mediaURL.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToPlaylist(List<com.bramosystems.oss.player.core.client.playlist.MRL> mediaLocators)
void	addToPlaylist(com.bramosystems.oss.player.core.client.playlist.MRL mediaLocator)
void	addToPlaylist(String... mediaURLs) Adds the media at the specified URLs to the players' playlist.
void	addToPlaylist(String mediaURL)
void	clearPlaylist()
int	getLoopCount()
long	getMediaDuration()
int	getPlaylistSize()
double	getPlayPosition()
double	getRate()
com.bramosystems.oss.player.core.client.RepeatMode	getRepeatMode()
int	getVideoHeight()
int	getVideoWidth()
double	getVolume()
boolean	isControllerVisible()
boolean	isResizeToVideoSize()
boolean	isShuffleEnabled()
void	loadMedia(String mediaURL)
protected void	onLoad() Overriden to register player for DOM events.
void	pauseMedia()
void	play(int index)
void	playMedia()
void	playNext()
void	playPrevious()
void	removeFromPlaylist(int index)
<C extends com.bramosystems.oss.player.core.client.ConfigParameter> void	setConfigParameter(C param, Object value)
void	setControllerVisible(boolean show) Displays or hides the player controls.
void	setLoopCount(int loop) Sets the number of times the current media file should repeat playback before stopping.
void	setPlayPosition(double position)
void	setRate(double rate)
void	setRepeatMode(com.bramosystems.oss.player.core.client.RepeatMode mode)
void	setResizeToVideoSize(boolean resize)
void	setShuffleEnabled(boolean enable)
void	setVolume(double volume)
void	stopMedia()

Methods inherited from class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

addDebugHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addLoadingProgressHandler, addMediaInfoHandler, addMouseDownHandler, addMouseMoveHandler, addMouseUpHandler, addPlayerStateHandler, addPlayStateHandler, addToPlayerReadyCommandQueue, fireDebug, fireError, fireLoadingProgress, fireMediaInfoAvailable, firePlayerStateEvent, firePlayStateEvent, getWidgetFactory, isPlayerOnPage, removeFromPlayerReadyCommandQueue

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

NativePlayer

public NativePlayer(String mediaURL)
             throws com.bramosystems.oss.player.core.client.PluginNotFoundException

Constructs NativePlayer to playback media located at mediaURL. Media playback begins automatically.

This is the same as calling NativePlayer(mediaURL, true, "20px", "100%")

Parameters:

mediaURL - the URL of the media to playback

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if browser does not support the HTML 5 specification.

NativePlayer

public NativePlayer(String mediaURL,
            boolean autoplay)
             throws com.bramosystems.oss.player.core.client.PluginNotFoundException

Constructs NativePlayer to playback media located at mediaURL. Media playback begins automatically if autoplay is true.

This is the same as calling NativePlayer(mediaURL, autoplay, "20px", "100%")

Parameters:

mediaURL - the URL of the media to playback

autoplay - true to start playing automatically, false otherwise

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if browser does not support the HTML 5 specification.

NativePlayer

public NativePlayer(String mediaURL,
            boolean autoplay,
            String height,
            String width)
             throws com.bramosystems.oss.player.core.client.PluginNotFoundException

Constructs NativePlayer with the specified height and width to playback media located at mediaURL. Media playback begins automatically if autoplay is true.

height and width are specified as CSS units.

Parameters:

mediaURL - the URL of the media to playback

autoplay - true to start playing automatically, false otherwise

height - the height of the player

width - the width of the player.

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if browser does not support the HTML 5 specification.

NativePlayer

public NativePlayer(ArrayList<String> mediaSources,
            boolean autoplay,
            String height,
            String width)
             throws com.bramosystems.oss.player.core.client.PluginNotFoundException

Constructs NativePlayer with the specified height and width to playback media located at any of the mediaSources. Playback begins automatically if autoplay is true.

As per the HTML 5 specification, the browser chooses any of the mediaSources it supports

height and width are specified as CSS units.

Parameters:

mediaSources - a list of media URLs

autoplay - true to start playing automatically, false otherwise

height - the height of the player

width - the width of the player.

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if browser does not support the HTML 5 specification.

Method Detail

onLoad

protected void onLoad()

Overriden to register player for DOM events.

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

loadMedia

public void loadMedia(String mediaURL)
               throws com.bramosystems.oss.player.core.client.LoadException

Specified by:

loadMedia in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

Throws:

com.bramosystems.oss.player.core.client.LoadException

playMedia

public void playMedia()
               throws com.bramosystems.oss.player.core.client.PlayException

Specified by:

playMedia in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

Throws:

com.bramosystems.oss.player.core.client.PlayException

stopMedia

public void stopMedia()

Specified by:

stopMedia in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

pauseMedia

public void pauseMedia()

Specified by:

pauseMedia in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getMediaDuration

public long getMediaDuration()

Specified by:

getMediaDuration in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getPlayPosition

public double getPlayPosition()

Specified by:

getPlayPosition in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setPlayPosition

public void setPlayPosition(double position)

Specified by:

setPlayPosition in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getVolume

public double getVolume()

Specified by:

getVolume in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setVolume

public void setVolume(double volume)

Specified by:

setVolume in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getLoopCount

public int getLoopCount()

Overrides:

getLoopCount in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getVideoHeight

public int getVideoHeight()

Overrides:

getVideoHeight in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getVideoWidth

public int getVideoWidth()

Overrides:

getVideoWidth in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

isControllerVisible

public boolean isControllerVisible()

Overrides:

isControllerVisible in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

isResizeToVideoSize

public boolean isResizeToVideoSize()

Overrides:

isResizeToVideoSize in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setControllerVisible

public void setControllerVisible(boolean show)

Displays or hides the player controls.

If this player is not available on the panel, this method call is added to the command-queue for later execution.

Overrides:

setControllerVisible in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setLoopCount

public void setLoopCount(int loop)

Sets the number of times the current media file should repeat playback before stopping.

If this player is not available on the panel, this method call is added to the command-queue for later execution.

Overrides:

setLoopCount in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setResizeToVideoSize

public void setResizeToVideoSize(boolean resize)

Overrides:

setResizeToVideoSize in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setRate

public void setRate(double rate)

Overrides:

setRate in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

getRate

public double getRate()

Overrides:

getRate in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setShuffleEnabled

public void setShuffleEnabled(boolean enable)

Specified by:

setShuffleEnabled in interface com.bramosystems.oss.player.core.client.PlaylistSupport

isShuffleEnabled

public boolean isShuffleEnabled()

Specified by:

isShuffleEnabled in interface com.bramosystems.oss.player.core.client.PlaylistSupport

addToPlaylist

public void addToPlaylist(String mediaURL)

Specified by:

addToPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

addToPlaylist

public void addToPlaylist(String... mediaURLs)

Adds the media at the specified URLs to the players' playlist. However, as per the HTML 5 specification, the browser chooses ONLY ONE of the mediaURLs it supports.

In respect of the same domain policy of some browsers, the URLs should point to a destination on the same domain where the application is hosted.

Specified by:

addToPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

Parameters:

mediaURLs - the alternative URLs of the same media (probably in different formats).

Since:

1.2

addToPlaylist

public void addToPlaylist(com.bramosystems.oss.player.core.client.playlist.MRL mediaLocator)

Specified by:

addToPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

addToPlaylist

public void addToPlaylist(List<com.bramosystems.oss.player.core.client.playlist.MRL> mediaLocators)

Specified by:

addToPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

removeFromPlaylist

public void removeFromPlaylist(int index)

Specified by:

removeFromPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

clearPlaylist

public void clearPlaylist()

Specified by:

clearPlaylist in interface com.bramosystems.oss.player.core.client.PlaylistSupport

playNext

public void playNext()
              throws com.bramosystems.oss.player.core.client.PlayException

Specified by:

playNext in interface com.bramosystems.oss.player.core.client.PlaylistSupport

Throws:

com.bramosystems.oss.player.core.client.PlayException

playPrevious

public void playPrevious()
                  throws com.bramosystems.oss.player.core.client.PlayException

Specified by:

playPrevious in interface com.bramosystems.oss.player.core.client.PlaylistSupport

Throws:

com.bramosystems.oss.player.core.client.PlayException

play

public void play(int index)
          throws IndexOutOfBoundsException

Specified by:

play in interface com.bramosystems.oss.player.core.client.PlaylistSupport

Throws:

IndexOutOfBoundsException

getPlaylistSize

public int getPlaylistSize()

Specified by:

getPlaylistSize in interface com.bramosystems.oss.player.core.client.PlaylistSupport

getRepeatMode

public com.bramosystems.oss.player.core.client.RepeatMode getRepeatMode()

Overrides:

getRepeatMode in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setRepeatMode

public void setRepeatMode(com.bramosystems.oss.player.core.client.RepeatMode mode)

Overrides:

setRepeatMode in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer

setConfigParameter

public <C extends com.bramosystems.oss.player.core.client.ConfigParameter> void setConfigParameter(C param,
                                                                                          Object value)

Overrides:

setConfigParameter in class com.bramosystems.oss.player.core.client.AbstractMediaPlayer