com.bramosystems.oss.player.provider.vimeo.client

Class VimeoUniversalPlayer

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.provider.vimeo.client.VimeoUniversalPlayer

All Implemented Interfaces:

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 VimeoUniversalPlayer
extends com.bramosystems.oss.player.core.client.AbstractMediaPlayer

Widget to embed Vimeo Universal Player.

Usage Example

 SimplePanel panel = new SimplePanel();   // create panel to hold the player
 Widget player = null;
 try {
      // create the player
      player = new VimeoUniversalPlayer("video-id", false, "100%", "350px");
 } catch(PluginVersionException e) {
      // catch plugin version exception and alert user to download plugin first.
      // An option is to use the utility method in PlayerUtil class.
      player = PlayerUtil.getMissingPluginNotice(e.getPlugin(), "Missing Plugin",
              ".. some nice message telling the user to click and download plugin first ..",
              false);
 } catch(PluginNotFoundException e) {
      // catch PluginNotFoundException and tell user to download plugin, possibly providing
      // a link to the plugin download page.
      player = new HTML(".. another kind of message telling the user to download plugin..");
 }

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

Since:

2.0

Author:

Sikiru 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
VimeoUniversalPlayer(String videoId, boolean autoplay, String width, String height) Creates a VimeoUniversalPlayer widget to playback the specified videoId.

Method Summary

Methods

Modifier and Type	Method and Description
long	getMediaDuration()
double	getPlayPosition()
com.bramosystems.oss.player.core.client.RepeatMode	getRepeatMode()
int	getVideoHeight()
int	getVideoWidth()
double	getVolume()
boolean	isControllerVisible() Returns the visibility state of the player controls.
void	loadMedia(String mediaURL) This implementation does nothing.
void	pauseMedia()
void	playMedia()
<C extends com.bramosystems.oss.player.core.client.ConfigParameter> void	setConfigParameter(C param, Object value)
void	setPlayPosition(double position)
void	setRepeatMode(com.bramosystems.oss.player.core.client.RepeatMode mode)
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, getLoopCount, getRate, getWidgetFactory, isPlayerOnPage, isResizeToVideoSize, removeFromPlayerReadyCommandQueue, setControllerVisible, setLoopCount, setRate, setResizeToVideoSize

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, onLoad, 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

VimeoUniversalPlayer

public VimeoUniversalPlayer(String videoId,
                    boolean autoplay,
                    String width,
                    String height)
                     throws com.bramosystems.oss.player.core.client.PluginNotFoundException,
                            com.bramosystems.oss.player.core.client.PluginVersionException

Creates a VimeoUniversalPlayer widget to playback the specified videoId.

Parameters:

videoId - the identifier of the video

autoplay - true to start playback automatically, false otherwise

width - the width of the player widget, in CSS units

height - the height of the player widget, in CSS units

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if the client browser is not HTML5 compliant

com.bramosystems.oss.player.core.client.PluginVersionException - not exactly thrown. Provided for Base API compatibility

Method Detail

loadMedia

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

This implementation does nothing. You will need to create another instance of the class to load a new media

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

setRepeatMode

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

Overrides:

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

getRepeatMode

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

Overrides:

getRepeatMode 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()

Returns the visibility state of the player controls.

This implementation ALWAYS return true

Overrides:

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

Returns:

true. Controller is always visible

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