|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.uibinder.client.PlayerWrapper<T>
T
- the player implementation typePlayer
, will be removed in future.
public abstract class PlayerWrapper<T extends AbstractMediaPlayer>
Provides the base implementation of player widgets with UiBinder support
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 | |
---|---|
protected com.google.gwt.user.client.ui.Widget |
missingPluginNotice
Deprecated. |
protected com.google.gwt.user.client.ui.Widget |
missingPluginVersionNotice
Deprecated. |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
protected |
PlayerWrapper(java.lang.String mediaURL,
boolean autoplay,
java.lang.String height,
java.lang.String width)
Deprecated. The constructor |
Method Summary | ||
---|---|---|
void |
addToPlaylist(java.util.List<MRL> mediaLocators)
Deprecated. Adds the media locators to the players' playlist. |
|
void |
addToPlaylist(MRL mediaLocator)
Deprecated. Adds the media locator to the players' playlist. |
|
void |
addToPlaylist(java.lang.String... mediaURLs)
Deprecated. Adds the media at the specified URLs to the players' playlist. |
|
void |
addToPlaylist(java.lang.String mediaURL)
Deprecated. Adds the media at the specified URL to the players' playlist. |
|
void |
clearPlaylist()
Deprecated. Removes all entries in the players' playlist |
|
T |
getEngine()
Deprecated. Returns the underlying player implementation |
|
int |
getLoopCount()
Deprecated. Returns the remaining number of times this player loops playback before stopping. |
|
TransformationMatrix |
getMatrix()
Deprecated. Retrieves the current transformation matrix of the player. |
|
long |
getMediaDuration()
Deprecated. Returns the duration of the loaded media in milliseconds. |
|
int |
getPlaylistSize()
Deprecated. Returns the number of entries in the playlist |
|
double |
getPlayPosition()
Deprecated. Gets the current position in the media that is being played. |
|
int |
getVideoHeight()
Deprecated. Returns the height of the current media |
|
int |
getVideoWidth()
Deprecated. Returns the width of the current media |
|
double |
getVolume()
Deprecated. Gets the volume ranging from 0 (silent) to 1 (full volume). |
|
protected abstract T |
initPlayerEngine(java.lang.String mediaURL,
boolean autoplay,
java.lang.String height,
java.lang.String width)
Deprecated. Called by the constructor to create the player implementation wrapped by this widget |
|
boolean |
isControllerVisible()
Deprecated. Checks whether the player controls are visible. |
|
boolean |
isResizeToVideoSize()
Deprecated. Checks if player is set to adjust its size to match the dimensions of a video. |
|
boolean |
isShuffleEnabled()
Deprecated. Checks if this player is in shuffle mode. |
|
void |
loadMedia(java.lang.String mediaURL)
Deprecated. Loads the media at the specified URL into the player. |
|
void |
onLoad()
Deprecated. |
|
void |
pauseMedia()
Deprecated. Pause the media playback |
|
void |
play(int index)
Deprecated. Play playlist entry at the specified index |
|
void |
playMedia()
Deprecated. Plays the media loaded into the player. |
|
void |
playNext()
Deprecated. Plays the next item in the playlist |
|
void |
playPrevious()
Deprecated. Plays the previous item in the playlist |
|
void |
removeFromPlaylist(int index)
Deprecated. Removes the entry at the specified index from the players' playlist. |
|
static java.lang.String |
resolveMediaURL(java.lang.String mediaURL)
Deprecated. Parses the mediaURL for gwt-host:: and gwt-module:: keywords. |
|
|
setConfigParameter(ConfigParameter param,
T value)
Deprecated. Sets the specified player parameter to the specified value IF AND ONLY IF the parameter is applicable on the player |
|
void |
setControllerVisible(boolean show)
Deprecated. Displays or hides the player controls. |
|
void |
setLoopCount(int loop)
Deprecated. Sets the number of times the current media file should loop playback before stopping. |
|
void |
setMatrix(TransformationMatrix matrix)
Deprecated. Sets the transformation matrix on the player |
|
void |
setPlayPosition(double position)
Deprecated. Sets the playback position of the current media |
|
void |
setResizeToVideoSize(boolean resize)
Deprecated. If the current media is a video, sets the player to adjust its size to match the dimensions of the video |
|
void |
setShowLogger(boolean show)
Deprecated. Convenience method for UiBinder support. |
|
void |
setShuffleEnabled(boolean enable)
Deprecated. Enables or disables players' shuffle mode. |
|
void |
setVolume(double volume)
Deprecated. Sets the volume. |
|
void |
showLogger(boolean show)
Deprecated. Displays or hides the players' logger widget. |
|
void |
stopMedia()
Deprecated. Stops the media playback. |
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, getRepeatMode, getWidgetFactory, isPlayerOnPage, removeFromPlayerReadyCommandQueue, setConfigParameter, setConfigParameter, setRate, setRepeatMode |
Methods inherited from class com.google.gwt.user.client.ui.Composite |
---|
getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addAttachHandler, 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, 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 |
---|
protected com.google.gwt.user.client.ui.Widget missingPluginNotice
protected com.google.gwt.user.client.ui.Widget missingPluginVersionNotice
Constructor Detail |
---|
protected PlayerWrapper(java.lang.String mediaURL, boolean autoplay, java.lang.String height, java.lang.String width)
mediaURL
- the URL of the media to playbackautoplay
- true
to autoplay, false
otherwiseheight
- the height of the player (in CSS units)width
- the width of the player (in CSS units)Method Detail |
---|
public static java.lang.String resolveMediaURL(java.lang.String mediaURL)
mediaURL
for gwt-host::
and gwt-module::
keywords.
The keywords are effectively replaced with their corresponding relative URLs.
gwt-host::
is replaced with GWT.getHostPageBaseURL()
while gwt-module::
is replaced with GWT.getModuleBaseURL()
mediaURL
- the mediaURL
public void onLoad()
onLoad
in class com.google.gwt.user.client.ui.Widget
public T getEngine()
protected abstract T initPlayerEngine(java.lang.String mediaURL, boolean autoplay, java.lang.String height, java.lang.String width) throws LoadException, PluginNotFoundException, PluginVersionException
mediaURL
- the resolved URL of the media to playbackautoplay
- true
to autoplay, false
otherwiseheight
- the height of the player (in CSS units)width
- the width of the player (in CSS units)
LoadException
- if an error occurs while loading the media.
PluginNotFoundException
- if the required plugin is not installed on the client.
PluginVersionException
- if the required plugin version is not installed on the client.public long getMediaDuration()
AbstractMediaPlayer
getMediaDuration
in class AbstractMediaPlayer
public double getPlayPosition()
AbstractMediaPlayer
getPlayPosition
in class AbstractMediaPlayer
public void setPlayPosition(double position)
AbstractMediaPlayer
setPlayPosition
in class AbstractMediaPlayer
position
- the new position from where to start playbackpublic void loadMedia(java.lang.String mediaURL) throws LoadException
AbstractMediaPlayer
In respect of the same domain
policy of some plugins,
the URL should point to a destination on the same domain
where the application is hosted.
loadMedia
in class AbstractMediaPlayer
mediaURL
- the URL of the media to load into the player.
LoadException
- if an error occurs while loading the mediapublic void pauseMedia()
AbstractMediaPlayer
pauseMedia
in class AbstractMediaPlayer
public void playMedia() throws PlayException
AbstractMediaPlayer
playMedia
in class AbstractMediaPlayer
PlayException
- if an error occurs
during media playback.public void stopMedia()
AbstractMediaPlayer
stopMedia
in class AbstractMediaPlayer
public double getVolume()
AbstractMediaPlayer
0
(silent) to 1
(full volume).
getVolume
in class AbstractMediaPlayer
public void setVolume(double volume)
AbstractMediaPlayer
setVolume
in class AbstractMediaPlayer
volume
- 0
(silent) to 1
(full volume).public int getLoopCount()
getLoopCount
in class AbstractMediaPlayer
public void setLoopCount(int loop)
setLoopCount
in class AbstractMediaPlayer
loop
- number of times to repeat playback. A negative value makes playback repeat forever!.public void showLogger(boolean show)
AbstractMediaPlayer
showLogger
in class AbstractMediaPlayer
show
- true
to make the logger widget visible, false
otherwise.Logger
public void setShowLogger(boolean show)
show
- true
to make the logger widget visible, false
otherwise.showLogger(boolean)
public int getVideoHeight()
AbstractMediaPlayer
getVideoHeight
in class AbstractMediaPlayer
public int getVideoWidth()
AbstractMediaPlayer
getVideoWidth
in class AbstractMediaPlayer
public boolean isControllerVisible()
AbstractMediaPlayer
isControllerVisible
in class AbstractMediaPlayer
true
if player controls are visible, false
otherwise.public boolean isResizeToVideoSize()
AbstractMediaPlayer
isResizeToVideoSize
in class AbstractMediaPlayer
true
if player adjusts its size, false
otherwisepublic <T extends ConfigValue> void setConfigParameter(ConfigParameter param, T value)
AbstractMediaPlayer
Note: The parameter-value pairs are applied as HTML param tags on the underlying player plugin, therefore this method should be called before adding this player to a panel otherwise the method call will have no effect.
setConfigParameter
in class AbstractMediaPlayer
T
- the paramter value typeparam
- the configuration parametervalue
- the parameter valuepublic void setControllerVisible(boolean show)
AbstractMediaPlayer
setControllerVisible
in class AbstractMediaPlayer
show
- true
to make the player controls visible, false
otherwise.public void setResizeToVideoSize(boolean resize)
AbstractMediaPlayer
setResizeToVideoSize
in class AbstractMediaPlayer
resize
- true
if player should adjust its size,
false
otherwisepublic void addToPlaylist(java.lang.String mediaURL)
PlaylistSupport
In respect of the same domain policy of some plugins/browsers, the URL should point to a destination on the same domain where the application is hosted.
addToPlaylist
in interface PlaylistSupport
mediaURL
- the URL of the media.public void addToPlaylist(MRL mediaLocator)
PlaylistSupport
addToPlaylist
in interface PlaylistSupport
mediaLocator
- specifies alternative URLs of the same mediapublic void addToPlaylist(java.lang.String... mediaURLs)
PlaylistSupport
The player 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.
addToPlaylist
in interface PlaylistSupport
mediaURLs
- the alternative URLs of the same media (probably in different formats).public void addToPlaylist(java.util.List<MRL> mediaLocators)
PlaylistSupport
addToPlaylist
in interface PlaylistSupport
mediaLocators
- list of alternative URLs of the same mediapublic boolean isShuffleEnabled()
PlaylistSupport
isShuffleEnabled
in interface PlaylistSupport
true
if player is in shuffle mode, false
otherwise.public void removeFromPlaylist(int index)
PlaylistSupport
removeFromPlaylist
in interface PlaylistSupport
index
- the index of the playlist entry.public void setShuffleEnabled(boolean enable)
PlaylistSupport
setShuffleEnabled
in interface PlaylistSupport
enable
- true
to enable shuffle, false
otherwisepublic void clearPlaylist()
PlaylistSupport
clearPlaylist
in interface PlaylistSupport
public int getPlaylistSize()
PlaylistSupport
getPlaylistSize
in interface PlaylistSupport
public void play(int index) throws java.lang.IndexOutOfBoundsException
PlaylistSupport
index
play
in interface PlaylistSupport
index
- number of the playlist entry
java.lang.IndexOutOfBoundsException
- if index
is outside the bounds of the playlistpublic void playNext() throws PlayException
PlaylistSupport
playNext
in interface PlaylistSupport
PlayException
- if there are no more entries in the playlist to be played. Especially if we've
advanced to the end of the playlist. Note: A player with a negative loop count (i.e. set to play
forever!) may not throw this exceptionpublic void playPrevious() throws PlayException
PlaylistSupport
playPrevious
in interface PlaylistSupport
PlayException
- if there are no more entries in the playlist to be played. Especially if we've
gotten to the beginning of the playlist. Note: A player with a negative loop count (i.e. set to play
forever!) may not throw this exceptionpublic void setMatrix(TransformationMatrix matrix)
MatrixSupport
setMatrix
in interface MatrixSupport
matrix
- the transformation matrixpublic TransformationMatrix getMatrix()
MatrixSupport
Note: Changing the properties of the returned object has no
effect on the transformation matrix of the underlying plugin. You will
have to call MatrixSupport.setMatrix(TransformationMatrix)
to effect any change.
getMatrix
in interface MatrixSupport
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |