com.bramosystems.oss.player.youtube.client

Class YouTubeBasePlayer

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.youtube.client.YouTubeBasePlayer

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

Direct Known Subclasses:

YouTubeIPlayer, YouTubePlayer

public abstract class YouTubeBasePlayer
extends com.bramosystems.oss.player.core.client.AbstractMediaPlayer

Base player widget to embed YouTube videos

Since:

2.0

Author:

Sikirulai Braheem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	YouTubeBasePlayer.DefaultEventHandler Default EventHandler implementation for YouTube player events.

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

Modifier and Type	Field and Description
protected String	_height
protected String	_vid
protected String	_width
protected HashMap<String,String>	configParam
protected com.bramosystems.oss.player.youtube.client.impl.YouTubePlayerImpl	impl
protected String	playerId
protected PlayerParameters	pParams

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YouTubeBasePlayer(String videoID, String width, String height, boolean useIframe) Constructs YouTubeBasePlayer with the specified height and width to playback video videoID

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addPlaybackQualityChangeHandler(PlaybackQualityChangeHandler handler) Adds a PlaybackQualityChangeHandler handler to the player
ArrayList<PlaybackQuality>	getAvailableQualityLevels() Returns the list of quality formats in which the current video is available.
int	getLoopCount()
long	getMediaDuration()
PlaybackQuality	getPlaybackQuality() Retrieves the playback quality of the current video.
double	getPlayPosition()
protected com.bramosystems.oss.player.youtube.client.impl.YouTubePlayerProvider	getProvider() Convenience method to retrieve the PlayerProvider implementation class
com.bramosystems.oss.player.core.client.RepeatMode	getRepeatMode()
double	getVolume()
boolean	isControllerVisible() Checks whether the player controls are visible.
void	loadMedia(String mediaURL)
protected String	paramsToString(PlayerParameters playerParameters) Converts the PlayerParameters object into YouTube™ video URL parameters.
void	pauseMedia()
void	playMedia()
<C extends com.bramosystems.oss.player.core.client.ConfigParameter> void	setConfigParameter(C param, Object value)
void	setLoopCount(int loop)
void	setPlaybackQuality(PlaybackQuality suggestedQuality) Sets the suggested video quality for the current video.
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, getRate, getVideoHeight, getVideoWidth, getWidgetFactory, isPlayerOnPage, isResizeToVideoSize, removeFromPlayerReadyCommandQueue, setControllerVisible, 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

Field Detail

impl

protected com.bramosystems.oss.player.youtube.client.impl.YouTubePlayerImpl impl

playerId

protected String playerId

_width

protected String _width

_height

protected String _height

_vid

protected String _vid

configParam

protected HashMap<String,String> configParam

pParams

protected PlayerParameters pParams

Constructor Detail

YouTubeBasePlayer

protected YouTubeBasePlayer(String videoID,
                 String width,
                 String height,
                 boolean useIframe)

Constructs YouTubeBasePlayer with the specified height and width to playback video videoID

height and width are specified as CSS units.

Parameters:

videoID - the ID of the video

width - the width of the player

height - the height of the player

Throws:

com.bramosystems.oss.player.core.client.PluginNotFoundException - if the required player plugin is not found

com.bramosystems.oss.player.core.client.PluginVersionException - if player plugin version not found

NullPointerException - if either videoID, height or width is null

Method Detail

paramsToString

protected final String paramsToString(PlayerParameters playerParameters)

Converts the PlayerParameters object into YouTube™ video URL parameters.

Parameters:

playerParameters - the player parameters

Returns:

the parameters in YouTube™ video URL format

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

setLoopCount

public void setLoopCount(int loop)

Overrides:

setLoopCount 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

setRepeatMode

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

Overrides:

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

isControllerVisible

public boolean isControllerVisible()

Checks whether the player controls are visible. This implementation always return true.

Overrides:

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

setPlaybackQuality

public void setPlaybackQuality(PlaybackQuality suggestedQuality)

Sets the suggested video quality for the current video. This method causes the video to reload at its current position in the new quality.

Note: Calling this method does not guarantee that the playback quality will actually change. If the playback quality does change, it will only change for the video being played and the PlaybackQualityChangeEvent event will be fired.

If suggestedQuality is not available for the current video, then the quality will be set to the next lowest level that is available. That is, if suggestedQuality is PlaybackQuality.hd720 and that is unavailable, then the playback quality will be set to PlaybackQuality.large if that quality level is available.

Parameters:

suggestedQuality - the suggested video quality for the current video

getPlaybackQuality

public PlaybackQuality getPlaybackQuality()
                                   throws IllegalStateException

Retrieves the playback quality of the current video.

Returns:

the playback quality of the current video

Throws:

IllegalStateException - if no video is loaded in the player

getAvailableQualityLevels

public ArrayList<PlaybackQuality> getAvailableQualityLevels()

Returns the list of quality formats in which the current video is available.

An empty list is returned if no video is loaded.

Returns:

a list of quality formats available for the current video

addPlaybackQualityChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addPlaybackQualityChangeHandler(PlaybackQualityChangeHandler handler)

Adds a PlaybackQualityChangeHandler handler to the player

Parameters:

handler - handler for the PlaybackQualityChangeEvent event

Returns:

HandlerRegistration used to remove the handler

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

getProvider

protected com.bramosystems.oss.player.youtube.client.impl.YouTubePlayerProvider getProvider()

Convenience method to retrieve the PlayerProvider implementation class

Returns:

the PlayerProvider implementation class for this player.