public abstract class CustomVideoPlayer extends AbstractMediaPlayer implements PlaylistSupport, MatrixSupport
The actual player plugin used to playback media files is wrapped by this player and hidden on the browser. This ensures that the player is controlled via the HTML controls provided by implementation classes.
Constructor and Description |
---|
CustomVideoPlayer(Plugin playerPlugin,
String mediaURL,
boolean autoplay,
String height,
String width)
Constructs
CustomVideoPlayer with the specified height and
width using the specified playerPlugin to playback media located
at mediaURL . |
Modifier and Type | Method and Description |
---|---|
void |
addToPlaylist(List<MRL> mediaLocators)
Adds the media locators to the players' playlist.
|
void |
addToPlaylist(MRL mediaLocator)
Adds the media locator to the players' playlist.
|
void |
addToPlaylist(String... mediaURLs)
Adds the media at the specified URLs to the players' playlist.
|
void |
addToPlaylist(String mediaURL)
Adds the media at the specified URL to the players' playlist.
|
void |
clearPlaylist()
Removes all entries in the players' playlist
|
int |
getLoopCount()
Returns the remaining number of times this player loops playback before stopping.
|
TransformationMatrix |
getMatrix()
Retrieves the current transformation matrix of the player.
|
long |
getMediaDuration()
Returns the duration of the loaded media in milliseconds.
|
int |
getPlaylistSize()
Returns the number of entries in the playlist
|
double |
getPlayPosition()
Gets the current position in the media that is being played.
|
double |
getRate()
Returns the current playback rate
|
RepeatMode |
getRepeatMode()
Returns the current playback repeat mode
|
int |
getVideoHeight()
Returns the height of the current media
|
int |
getVideoWidth()
Returns the width of the current media
|
double |
getVolume()
Gets the volume ranging from
0 (silent) to 1 (full volume). |
protected void |
initWidget(com.google.gwt.user.client.ui.Widget widget)
Overridden to prevent subclasses from changing the wrapped widget.
|
boolean |
isControllerVisible()
Checks whether the player controls are visible.
|
boolean |
isResizeToVideoSize()
Checks if player is set to adjust its size to match the dimensions of a video.
|
boolean |
isShuffleEnabled()
Checks if this player is in shuffle mode.
|
void |
loadMedia(String mediaURL)
Loads the media at the specified URL into the player.
|
protected abstract void |
onVideoDimensionChanged(int width,
int height)
Called when the size of the embedded player changes to match the dimension of
the media (especially video)
|
void |
pauseMedia()
Pause the media playback
|
void |
play(int index)
Play playlist entry at the specified
index |
void |
playMedia()
Plays the media loaded into the player.
|
void |
playNext()
Plays the next item in the playlist
|
void |
playPrevious()
Plays the previous item in the playlist
|
void |
removeFromPlaylist(int index)
Removes the entry at the specified index from the players' playlist.
|
<C extends ConfigParameter> |
setConfigParameter(C param,
Object value)
Sets the specified player parameter to the specified value IF AND ONLY IF the
parameter is applicable on the player
|
void |
setControllerVisible(boolean show)
Displays or hides the player controls.
|
void |
setLoopCount(int loop)
Sets the number of times the current media file should loop playback before stopping.
|
void |
setMatrix(TransformationMatrix matrix)
Sets the transformation matrix on the player
|
protected void |
setPlayerControlWidget(com.google.gwt.user.client.ui.Widget widget)
Sets the widget that will be used to control the player plugin.
|
void |
setPlayPosition(double position)
Sets the playback position of the current media
|
void |
setRate(double rate)
Sets the playback rate.
|
void |
setRepeatMode(RepeatMode mode)
Puts the player in the specified repeat mode.
|
void |
setResizeToVideoSize(boolean resize)
If the current media is a video, sets the player to adjust its size to match the
dimensions of the video
|
void |
setShuffleEnabled(boolean enable)
Enables or disables players' shuffle mode.
|
void |
setVolume(double volume)
Sets the volume.
|
void |
stopMedia()
Stops the media playback.
|
addDebugHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addLoadingProgressHandler, addMediaInfoHandler, addMouseDownHandler, addMouseMoveHandler, addMouseUpHandler, addPlayerStateHandler, addPlayStateHandler, addToPlayerReadyCommandQueue, fireDebug, fireError, fireLoadingProgress, fireMediaInfoAvailable, firePlayerStateEvent, firePlayStateEvent, getWidgetFactory, isPlayerOnPage, removeFromPlayerReadyCommandQueue
claimElement, getWidget, initializeClaimedElement, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
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
public CustomVideoPlayer(Plugin playerPlugin, String mediaURL, boolean autoplay, String height, String width) throws PluginNotFoundException, PluginVersionException, LoadException
CustomVideoPlayer
with the specified height
and
width
using the specified playerPlugin
to playback media located
at mediaURL
. Media playback begins automatically if autoplay
is true
.playerPlugin
- the plugin to use for playback.mediaURL
- the URL of the media to playbackautoplay
- true
to start playing automatically, false
otherwiseheight
- the height of the playerwidth
- the width of the player.PluginVersionException
- if the required player plugin version is not installed on the client.PluginNotFoundException
- if the player plugin is not installed on the client.NullPointerException
- if height
or width
is null
LoadException
Plugin
protected final void initWidget(com.google.gwt.user.client.ui.Widget widget)
setPlayerControlWidget
instead.initWidget
in class com.google.gwt.user.client.ui.Composite
setPlayerControlWidget(com.google.gwt.user.client.ui.Widget)
protected final void setPlayerControlWidget(com.google.gwt.user.client.ui.Widget widget)
Subclasses should call this method before calling any method that targets this widget.
widget
- the player control widgetpublic 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(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 addToPlaylist(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(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(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 IndexOutOfBoundsException
PlaylistSupport
index
play
in interface PlaylistSupport
index
- number of the playlist entryIndexOutOfBoundsException
- 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 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 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 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
public void setMatrix(TransformationMatrix matrix)
MatrixSupport
setMatrix
in interface MatrixSupport
matrix
- the transformation matrixprotected abstract void onVideoDimensionChanged(int width, int height)
This method is called whenever the PlayerStateEvent
event is fired
with State.DimensionChangedOnVideo
state.
width
- the width of the media (in pixels)height
- the height of the media (in pixels)public double getRate()
AbstractMediaPlayer
getRate
in class AbstractMediaPlayer
AbstractMediaPlayer.setRate(double)
public RepeatMode getRepeatMode()
AbstractMediaPlayer
getRepeatMode
in class AbstractMediaPlayer
RepeatMode
public <C extends ConfigParameter> void setConfigParameter(C param, Object 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
C
- the paramter value typeparam
- the configuration parametervalue
- the parameter valuepublic void setRate(double rate)
AbstractMediaPlayer
If this player is not available on the panel, this method call is added to the command-queue for later execution.
setRate
in class AbstractMediaPlayer
rate
- the playback rate. A rate of 1 implies normal playback rate,
fractional values are slow motion, and values greater than one are fast-forwardpublic void setRepeatMode(RepeatMode mode)
AbstractMediaPlayer
The effect of the specified mode depends on the AbstractMediaPlayer.setLoopCount(int)
property as
shown in the table:
Value of loopCount |
Value of repeatMode |
What it means? |
---|---|---|
Any value < 0 | Sets repeatMode to RepeatMode.REPEAT_ALL |
Playlist is repeated continously |
1 | RepeatMode.REPEAT_OFF |
Entire playlist is played only once |
RepeatMode.REPEAT_ONE |
The current playlist entry is repeated continously | |
RepeatMode.REPEAT_ALL |
Entire playlist is repeated continously | |
Any value > 1 | RepeatMode.REPEAT_OFF |
The loopCount property is ignored, and the entire playlist is played only once |
RepeatMode.REPEAT_ONE |
Player repeats each playlist entry for the number of times specified by loopCount
and moves on the next until all entries are played and stops |
|
RepeatMode.REPEAT_ALL |
Player repeats entire playlist for the number of times specified by loopCount and stops |
setRepeatMode
in class AbstractMediaPlayer
mode
- the new repeat modeRepeatMode
Copyright © 2009-2013. All Rights Reserved.