Class MediaBase
- All Implemented Interfaces:
HasAllDragAndDropHandlers
,HasAllFocusHandlers
,HasAllGestureHandlers
,HasAllKeyHandlers
,HasAllMediaHandlers
,HasAllMouseHandlers
,HasAllTouchHandlers
,HasBlurHandlers
,HasCanPlayThroughHandlers
,HasClickHandlers
,HasDoubleClickHandlers
,HasDragEndHandlers
,HasDragEnterHandlers
,HasDragHandlers
,HasDragLeaveHandlers
,HasDragOverHandlers
,HasDragStartHandlers
,HasDropHandlers
,HasEndedHandlers
,HasFocusHandlers
,HasGestureChangeHandlers
,HasGestureEndHandlers
,HasGestureStartHandlers
,HasKeyDownHandlers
,HasKeyPressHandlers
,HasKeyUpHandlers
,HasLoadedMetadataHandlers
,HasMouseDownHandlers
,HasMouseMoveHandlers
,HasMouseOutHandlers
,HasMouseOverHandlers
,HasMouseUpHandlers
,HasMouseWheelHandlers
,HasProgressHandlers
,HasTouchCancelHandlers
,HasTouchEndHandlers
,HasTouchMoveHandlers
,HasTouchStartHandlers
,HasAttachHandlers
,HasHandlers
,EventListener
,Focusable
,HasEnabled
,HasFocus
,HasVisibility
,IsWidget
,SourcesClickEvents
,SourcesFocusEvents
,SourcesKeyboardEvents
,SourcesMouseEvents
A widget representing a media element.
Experimental API: This API is still under development and is subject to change.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
-
Field Summary
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdds aCanPlayThroughEvent
handler.addEndedHandler
(EndedHandler handler) Adds aEndedEvent
handler.Adds aLoadedMetadataEvent
handler.addProgressHandler
(ProgressHandler handler) Adds aProgressEvent
handler.Add a source element to this media.Add a source element to this media, specifying the type (format) of the media.canPlayType
(String type) Returnstrue
if the native player is capable of playing content of the given MIME type.Returns aTimeRanges
object indicating which portions of the source have been buffered locally.Returns the URL of the current media source, or the empty String if no source is set.double
Returns the current time within the source media stream.double
Returns the default playback rate, where 1.0 corresponds to normal playback.double
Returns the duration of the source media stream, in seconds.getError()
Returns the type of error that has occurred while attempting to load and play the media.double
Returns the time to which the media stream was seeked at the time it was loaded, in seconds, or 0.0 if the position is unknown.Returns the attached Media Element.int
Returns the network state, one ofMediaElement.NETWORK_EMPTY
,MediaElement.NETWORK_IDLE
,MediaElement.NETWORK_LOADING
, orMediaElement.NETWORK_NO_SOURCE
.double
Returns the playback rate, where 1.0 corresponds to normal playback.Returns aTimeRanges
object indicating which portions of the source have been played.Returns the preload setting, one ofMediaElement.PRELOAD_AUTO
,MediaElement.PRELOAD_METADATA
, orMediaElement.PRELOAD_NONE
.int
Returns the current state of the media with respect to rendering the current playback position, as one of the constantsMediaElement.HAVE_CURRENT_DATA
,MediaElement.HAVE_ENOUGH_DATA
,MediaElement.HAVE_FUTURE_DATA
,MediaElement.HAVE_METADATA
, orMediaElement.HAVE_NOTHING
.Returns aTimeRanges
object indicating which portions of the source are seekable.getSrc()
Returns the source URL for the media, ornull
if none is set.double
Returns the time corresponding to the zero time in the media timeline, measured in seconds since midnight, January 1 1970 UTC, orDouble.NaN
if none is specified.double
Returns the current audio volume setting for the media, as a number between 0.0 and 1.0.boolean
Returnstrue
if the media player should display interactive controls (for example, to control play/pause, seek position, and volume),false
otherwise.boolean
hasEnded()
Returnstrue
if playback has reached the end of the media,false
otherwise.boolean
Returnstrue
if autoplay is enabled,false
otherwise.boolean
isLoop()
Returnstrue
if the user agent is to seek back to the start of the media once playing has ended,false
otherwise.boolean
isMuted()
Returnstrue
if the volume is to be muted (overriding the normal volume setting),false
otherwise.boolean
isPaused()
Returnstrue
if playback is paused,false
otherwise.boolean
Returnstrue
if the playback position is in the process of changing discontinuously, e.g., by use of the interactive controls,false
otherwise.void
load()
Causes the resource to be loaded.void
pause()
Causes playback of the resource to be paused.void
play()
Causes playback of the resource to be started or resumed.void
removeSource
(SourceElement source) Remove the specifiedSourceElement
from this media.void
setAutoplay
(boolean autoplay) Enables or disables autoplay of the resource.void
setControls
(boolean controls) Enables or disables interactive controls.void
setCurrentTime
(double time) Sets the current playback time within the media stream, in seconds.void
setDefaultPlaybackRate
(double rate) Sets the default playback rate.final void
setLoop
(boolean loop) Enables or disables looping.void
setMuted
(boolean muted) Enables or disables muting.void
setPlaybackRate
(double rate) Sets the playback rate.void
setPreload
(String preload) Changes the preload setting to one ofMediaElement.PRELOAD_AUTO
,MediaElement.PRELOAD_METADATA
, orMediaElement.PRELOAD_NONE
.void
Sets the source URL for the media.void
setVolume
(double volume) Sets the playback volume.Methods inherited from class com.google.gwt.user.client.ui.FocusWidget
addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, getTabIndex, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex
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, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
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, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
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 Details
-
MediaBase
Protected constructor.
-
-
Method Details
-
addCanPlayThroughHandler
Description copied from interface:HasCanPlayThroughHandlers
Adds aCanPlayThroughEvent
handler.- Specified by:
addCanPlayThroughHandler
in interfaceHasCanPlayThroughHandlers
- Parameters:
handler
- the media CanPlayThrough handler- Returns:
HandlerRegistration
used to remove this handler
-
addEndedHandler
Description copied from interface:HasEndedHandlers
Adds aEndedEvent
handler.- Specified by:
addEndedHandler
in interfaceHasEndedHandlers
- Parameters:
handler
- the media ended handler- Returns:
HandlerRegistration
used to remove this handler
-
addProgressHandler
Description copied from interface:HasProgressHandlers
Adds aProgressEvent
handler.- Specified by:
addProgressHandler
in interfaceHasProgressHandlers
- Parameters:
handler
- the media progress handler- Returns:
HandlerRegistration
used to remove this handler
-
addLoadedMetadataHandler
Description copied from interface:HasLoadedMetadataHandlers
Adds aLoadedMetadataEvent
handler.- Specified by:
addLoadedMetadataHandler
in interfaceHasLoadedMetadataHandlers
- Parameters:
handler
- the media loadedmetadata handler- Returns:
HandlerRegistration
used to remove this handler
-
addSource
Add a source element to this media. The browser will request source files from the server until it finds one it can play.Only use this method if you do not know the type of the source file, as the browser cannot determine the format from the filename and must download each source until a compatible one is found. Instead, you should specify the type for the media using
addSource(String, String)
so the browser can choose a source file without downloading the file.- Parameters:
url
- a String URL- See Also:
-
addSource
Add a source element to this media, specifying the type (format) of the media. The browser will choose a supported source file and download it.The type is the format or encoding of the media represented by the source element. For example, the type of an
AudioElement
could be one of "audio/ogg",AudioElement.TYPE_MP3
, orAudioElement.TYPE_WAV
.You can also add the codec information to the type, giving the browser even more information about whether or not it can play the file (Example: "
audio/ogg; codec=vorbis
");- Parameters:
url
- a String URLtype
- the type (format) of the media- See Also:
-
canPlayType
Returnstrue
if the native player is capable of playing content of the given MIME type.- Parameters:
type
- a String representing a MIME type- Returns:
- one of
MediaElement.CAN_PLAY_PROBABLY
,MediaElement.CAN_PLAY_MAYBE
, orMediaElement.CANNOT_PLAY
-
getBuffered
Returns aTimeRanges
object indicating which portions of the source have been buffered locally.- Returns:
- a
TimeRanges
instance, ornull
.
-
getCurrentSrc
Returns the URL of the current media source, or the empty String if no source is set.- Returns:
- a String URL
-
getCurrentTime
public double getCurrentTime()Returns the current time within the source media stream.- Returns:
- the time, in seconds, as a double
- See Also:
-
getDefaultPlaybackRate
public double getDefaultPlaybackRate()Returns the default playback rate, where 1.0 corresponds to normal playback. If no rate has been set, 1.0 is returned.- Returns:
- the current default playback rate, or 1.0 if it has not been set
- See Also:
-
getDuration
public double getDuration()Returns the duration of the source media stream, in seconds. If the duration is unknown,Double.NaN
is returned. For unbounded media streams,Double.POSITIVE_INFINITY
is returned.- Returns:
- a positive duration in seconds, NaN, or Infinity
-
getError
Returns the type of error that has occurred while attempting to load and play the media. If no error has occurred,null
is returned.- Returns:
- a
MediaError
instance, ornull
-
getInitialTime
public double getInitialTime()Returns the time to which the media stream was seeked at the time it was loaded, in seconds, or 0.0 if the position is unknown.- Returns:
- the initial time, or 0.0 if unknown
-
getMediaElement
Returns the attached Media Element.- Returns:
- the Media Element
-
getNetworkState
public int getNetworkState()Returns the network state, one ofMediaElement.NETWORK_EMPTY
,MediaElement.NETWORK_IDLE
,MediaElement.NETWORK_LOADING
, orMediaElement.NETWORK_NO_SOURCE
.- Returns:
- an integer constant indicating the network state
- See Also:
-
getPlaybackRate
public double getPlaybackRate()Returns the playback rate, where 1.0 corresponds to normal playback. If the rate has not been set, 1.0 is returned.- Returns:
- the playback rate, if known, otherwise 1.0
- See Also:
-
getPlayed
Returns aTimeRanges
object indicating which portions of the source have been played.- Returns:
- a
TimeRanges
instance, ornull
.
-
getPreload
Returns the preload setting, one ofMediaElement.PRELOAD_AUTO
,MediaElement.PRELOAD_METADATA
, orMediaElement.PRELOAD_NONE
.- Returns:
- the preload setting
- See Also:
-
getReadyState
public int getReadyState()Returns the current state of the media with respect to rendering the current playback position, as one of the constantsMediaElement.HAVE_CURRENT_DATA
,MediaElement.HAVE_ENOUGH_DATA
,MediaElement.HAVE_FUTURE_DATA
,MediaElement.HAVE_METADATA
, orMediaElement.HAVE_NOTHING
.- Returns:
- an integer constant indicating the ready state
- See Also:
-
getSeekable
Returns aTimeRanges
object indicating which portions of the source are seekable.- Returns:
- a
TimeRanges
instance, ornull
.
-
getSrc
Returns the source URL for the media, ornull
if none is set.- Returns:
- a String URL or
null
- See Also:
-
getStartOffsetTime
public double getStartOffsetTime()Returns the time corresponding to the zero time in the media timeline, measured in seconds since midnight, January 1 1970 UTC, orDouble.NaN
if none is specified.- Returns:
- the start time
-
getVolume
public double getVolume()Returns the current audio volume setting for the media, as a number between 0.0 and 1.0.- Returns:
- a number between 0.0 (silent) and 1.0 (loudest)
- See Also:
-
hasControls
public boolean hasControls()Returnstrue
if the media player should display interactive controls (for example, to control play/pause, seek position, and volume),false
otherwise.- Returns:
- whether controls should be displayed
- See Also:
-
hasEnded
public boolean hasEnded()Returnstrue
if playback has reached the end of the media,false
otherwise.- Returns:
- whether playback has ended
-
isAutoplay
public boolean isAutoplay()Returnstrue
if autoplay is enabled,false
otherwise. When autoplay is enabled, the user agent will begin playback automatically as soon as it can do so without stopping.- Returns:
- the autoplay setting
- See Also:
-
isLoop
public boolean isLoop()Returnstrue
if the user agent is to seek back to the start of the media once playing has ended,false
otherwise.- Returns:
- the loop setting
- See Also:
-
isMuted
public boolean isMuted()Returnstrue
if the volume is to be muted (overriding the normal volume setting),false
otherwise.- Returns:
- the muting setting
- See Also:
-
isPaused
public boolean isPaused()Returnstrue
if playback is paused,false
otherwise. -
isSeeking
public boolean isSeeking()Returnstrue
if the playback position is in the process of changing discontinuously, e.g., by use of the interactive controls,false
otherwise.- Returns:
- the seeking status
- See Also:
-
load
public void load()Causes the resource to be loaded. -
pause
public void pause()Causes playback of the resource to be paused. -
play
public void play()Causes playback of the resource to be started or resumed. -
removeSource
Remove the specifiedSourceElement
from this media. If the source element is not a child of this widget, it will not be removed.- Parameters:
source
- the source element to remove- See Also:
-
setAutoplay
public void setAutoplay(boolean autoplay) Enables or disables autoplay of the resource.- Parameters:
autoplay
- iftrue
, enable autoplay- See Also:
-
setControls
public void setControls(boolean controls) Enables or disables interactive controls.- Parameters:
controls
- iftrue
, enable controls- See Also:
-
setCurrentTime
public void setCurrentTime(double time) Sets the current playback time within the media stream, in seconds.- Parameters:
time
- a number within the ranges given bygetSeekable()
- See Also:
-
setDefaultPlaybackRate
public void setDefaultPlaybackRate(double rate) Sets the default playback rate.- Parameters:
rate
- a double value- See Also:
-
setLoop
public final void setLoop(boolean loop) Enables or disables looping.- Parameters:
loop
- iftrue
, enable looping- See Also:
-
setMuted
public void setMuted(boolean muted) Enables or disables muting.- Parameters:
muted
- iftrue
, enable muting- See Also:
-
setPlaybackRate
public void setPlaybackRate(double rate) Sets the playback rate.- Parameters:
rate
- a double value- See Also:
-
setPreload
Changes the preload setting to one ofMediaElement.PRELOAD_AUTO
,MediaElement.PRELOAD_METADATA
, orMediaElement.PRELOAD_NONE
.- Parameters:
preload
- a String constants- See Also:
-
setSrc
Sets the source URL for the media.Support for different media types varies between browsers. Instead of using this method, you should encode your media in multiple formats and add all of them using
addSource(String, String)
so the browser can choose a source that it supports.- Parameters:
url
- a String URL- See Also:
-
setVolume
public void setVolume(double volume) Sets the playback volume.- Parameters:
volume
- a value between 0.0 (silent) and 1.0 (loudest)- See Also:
-