public class

MediaElement

extends Element

java.lang.Object
↳	com.google.gwt.core.client.JavaScriptObject
	↳	com.google.gwt.dom.client.Node
		↳	com.google.gwt.dom.client.Element
			↳	com.google.gwt.dom.client.MediaElement

Known Direct Subclasses

AudioElement, VideoElement

Class Overview

Common superclass for Audio and Video elements. See W3C HTML5 Video and Audio

Summary

Constants
String	CANNOT_PLAY	Constant returned from `canPlayType(String)`.
String	CAN_PLAY_MAYBE	Constant returned from `canPlayType(String)`.
String	CAN_PLAY_PROBABLY	Constant returned from `canPlayType(String)`.
int	HAVE_CURRENT_DATA	Constant returned from `getReadyState()`.
int	HAVE_ENOUGH_DATA	Constant returned from `getReadyState()`.
int	HAVE_FUTURE_DATA	Constant returned from `getReadyState()`.
int	HAVE_METADATA	Constant returned from `getReadyState()`.
int	HAVE_NOTHING	Constant returned from `getReadyState()`.
int	NETWORK_EMPTY	Constant returned from `getNetworkState()`.
int	NETWORK_IDLE	Constant returned from `getNetworkState()`.
int	NETWORK_LOADING	Constant returned from `getNetworkState()`.
int	NETWORK_NO_SOURCE	Constant returned from `getNetworkState()`.
String	PRELOAD_AUTO	Constant used by `getPreload()` and `setPreload(String)`.
String	PRELOAD_METADATA	Constant used by `getPreload()` and `setPreload(String)`.
String	PRELOAD_NONE	Constant used by `getPreload()` and `setPreload(String)`.

[Expand]

Inherited Constants

From class com.google.gwt.dom.client.Node

Protected Constructors
	MediaElement()

Public Methods
final String	canPlayType(String type) Returns `true` if the native player is capable of playing content of the given MIME type.
final TimeRanges	getBuffered() Returns a `TimeRanges` object indicating which portions of the source have been buffered locally.
final String	getCurrentSrc() Returns the URL of the current media source, or the empty String if no source is set.
final double	getCurrentTime() Returns the current time within the source media stream.
final double	getDefaultPlaybackRate() Returns the default playback rate, where 1.0 corresponds to normal playback.
final double	getDuration() Returns the duration of the source media stream, in seconds.
final MediaError	getError() Returns the type of error that has occurred while attempting to load and play the media.
final 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.
final int	getNetworkState() Returns the network state, one of `NETWORK_EMPTY`, `NETWORK_IDLE`, `NETWORK_LOADING`, or `NETWORK_NO_SOURCE`.
final double	getPlaybackRate() Returns the playback rate, where 1.0 corresponds to normal playback.
final TimeRanges	getPlayed() Returns a `TimeRanges` object indicating which portions of the source have been played.
final String	getPreload() Returns the preload setting, one of `PRELOAD_AUTO`, `PRELOAD_METADATA`, or `PRELOAD_NONE`.
final int	getReadyState() Returns the current state of the media with respect to rendering the current playback position, as one of the constants `HAVE_CURRENT_DATA`, `HAVE_ENOUGH_DATA`, `HAVE_FUTURE_DATA`, `HAVE_METADATA`, or `HAVE_NOTHING` .
final TimeRanges	getSeekable() Returns a `TimeRanges` object indicating which portions of the source are seekable.
final String	getSrc() Returns the source URL for the media, or `null` if none is set.
final double	getStartOffsetTime() Returns the time corresponding to the zero time in the media timeline, measured in seconds since midnight, January 1 1970 UTC, or `NaN` if none is specified.
final double	getVolume() Returns the current audio volume setting for the media, as a number between 0.0 and 1.0.
final boolean	hasControls() Returns `true` if the media player should display interactive controls (for example, to control play/pause, seek position, and volume), `false` otherwise.
final boolean	hasEnded() Returns `true` if playback has reached the end of the media, `false` otherwise.
final boolean	isAutoplay() Returns `true` if autoplay is enabled, `false` otherwise.
final boolean	isLoop() Returns `true` if the user agent is to seek back to the start of the media once playing has ended, `false` otherwise.
final boolean	isMuted() Returns `true` if the volume is to be muted (overriding the normal volume setting), `false` otherwise.
final boolean	isPaused() Returns `true` if playback is paused, `false` otherwise.
final boolean	isSeeking() Returns `true` if the playback position is in the process of changing discontinuously, e.g., by use of the interactive controls, `false` otherwise.
final void	load() Causes the resource to be loaded.
final void	pause() Causes playback of the resource to be paused.
final void	play() Causes playback of the resource to be started or resumed.
final void	setAutoplay(boolean autoplay) Enables or disables autoplay of the resource.
final void	setControls(boolean controls) Enables or disables interactive controls.
final void	setCurrentTime(double time) Sets the current playback time within the media stream, in seconds.
final void	setDefaultPlaybackRate(double rate) Sets the default playback rate.
final void	setLoop(boolean loop) Enables or disables looping.
final void	setMuted(boolean muted) Enables or disables muting.
final void	setPlaybackRate(double rate) Sets the playback rate.
final void	setPreload(String preload) Changes the preload setting to one of `PRELOAD_AUTO`, `PRELOAD_METADATA`, or `PRELOAD_NONE`.
final void	setSrc(String url) Sets the source URL for the media.
final void	setVolume(double volume) Sets the playback volume.

[Expand]

Inherited Methods

From class com.google.gwt.dom.client.Element

final void	addClassName(String className) Adds a name to this element's class property.
static Element	as(JavaScriptObject o) Assert that the given `Node` is an `Element` and automatically typecast it.
static Element	as(Node node) Assert that the given `Node` is an `Element` and automatically typecast it.
final void	blur() Removes keyboard focus from this element.
final void	dispatchEvent(NativeEvent evt) Dispatched the given event with this element as its target.
final void	focus() Gives keyboard focus to this element.
final int	getAbsoluteBottom() Gets an element's absolute bottom coordinate in the document's coordinate system.
final int	getAbsoluteLeft() Gets an element's absolute left coordinate in the document's coordinate system.
final int	getAbsoluteRight() Gets an element's absolute right coordinate in the document's coordinate system.
final int	getAbsoluteTop() Gets an element's absolute top coordinate in the document's coordinate system.
final String	getAttribute(String name) Retrieves an attribute value by name.
final String	getClassName() The class attribute of the element.
final int	getClientHeight() Returns the inner height of an element in pixels, including padding but not the horizontal scrollbar height, border, or margin.
final int	getClientWidth() Returns the inner width of an element in pixels, including padding but not the vertical scrollbar width, border, or margin.
final String	getDir() Specifies the base direction of directionally neutral text and the directionality of tables.
final NodeList<Element>	getElementsByTagName(String name) Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.
final Element	getFirstChildElement() The first child of element this element.
final String	getId() The element's identifier.
final String	getInnerHTML() All of the markup and content within a given element.
final String	getInnerText() The text between the start and end tags of the object.
final String	getLang() Language code defined in RFC 1766.
final Element	getNextSiblingElement() The element immediately following this element.
final int	getOffsetHeight() The height of an element relative to the layout.
final int	getOffsetLeft() The number of pixels that the upper left corner of the current element is offset to the left within the offsetParent node.
final Element	getOffsetParent() Returns a reference to the object which is the closest (nearest in the containment hierarchy) positioned containing element.
final int	getOffsetTop() The number of pixels that the upper top corner of the current element is offset to the top within the offsetParent node.
final int	getOffsetWidth() The width of an element relative to the layout.
final boolean	getPropertyBoolean(String name) Gets a boolean property from this element.
final double	getPropertyDouble(String name) Gets a double property from this element.
final int	getPropertyInt(String name) Gets an integer property from this element.
final JavaScriptObject	getPropertyJSO(String name) Gets a JSO property from this element.
final Object	getPropertyObject(String name) Gets an object property from this element.
final String	getPropertyString(String name) Gets a property from this element.
final int	getScrollHeight() The height of the scroll view of an element.
final int	getScrollLeft() The number of pixels that an element's content is scrolled from the left.
final int	getScrollTop() The number of pixels that an element's content is scrolled from the top.
final int	getScrollWidth() The width of the scroll view of an element.
final String	getString() Gets a string representation of this element (as outer HTML).
final Style	getStyle() Gets this element's `Style` object.
final int	getTabIndex() The index that represents the element's position in the tabbing order.
final String	getTagName() Gets the element's full tag name, including the namespace-prefix if present.
final String	getTitle() The element's advisory title.
final boolean	hasAttribute(String name) Determines whether an element has an attribute with a given name.
final boolean	hasTagName(String tagName) Determines whether this element has the given tag name.
static boolean	is(Node node) Determine whether the given `Node` can be cast to an `Element`.
static boolean	is(JavaScriptObject o) Determines whether the given `JavaScriptObject` can be cast to an `Element`.
final void	removeAttribute(String name) Removes an attribute by name.
final void	removeClassName(String className) Removes a name from this element's class property.
final void	replaceClassName(String oldClassName, String newClassName) Replace one class name with another.
final void	scrollIntoView() Scrolls this element into view.
final void	setAttribute(String name, String value) Adds a new attribute.
final void	setClassName(String className) The class attribute of the element.
final void	setDir(String dir) Specifies the base direction of directionally neutral text and the directionality of tables.
final void	setId(String id) The element's identifier.
final void	setInnerHTML(String html) All of the markup and content within a given element.
final void	setInnerText(String text) The text between the start and end tags of the object.
final void	setLang(String lang) Language code defined in RFC 1766.
final void	setPropertyBoolean(String name, boolean value) Sets a boolean property on this element.
final void	setPropertyDouble(String name, double value) Sets a double property on this element.
final void	setPropertyInt(String name, int value) Sets an integer property on this element.
final void	setPropertyJSO(String name, JavaScriptObject value) Sets a JSO property on this element.
final void	setPropertyObject(String name, Object value) Sets an object property on this element.
final void	setPropertyString(String name, String value) Sets a property on this element.
final void	setScrollLeft(int scrollLeft) The number of pixels that an element's content is scrolled to the left.
final void	setScrollTop(int scrollTop) The number of pixels that an element's content is scrolled to the top.
final void	setTabIndex(int tabIndex) The index that represents the element's position in the tabbing order.
final void	setTitle(String title) The element's advisory title.

From class com.google.gwt.dom.client.Node

final <T extends Node> T	appendChild(T newChild) Adds the node newChild to the end of the list of children of this node.
static Node	as(JavaScriptObject o) Assert that the given `JavaScriptObject` is a DOM node and automatically typecast it.
final Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
final Node	getChild(int index) Gets the child node at the given index.
final int	getChildCount() Gets the number of child nodes contained within this node.
final NodeList<Node>	getChildNodes() A NodeList that contains all children of this node.
final Node	getFirstChild() The first child of this node.
final Node	getLastChild() The last child of this node.
final Node	getNextSibling() The node immediately following this node.
final String	getNodeName() The name of this node, depending on its type; see the table above.
final short	getNodeType() A code representing the type of the underlying object, as defined above.
final String	getNodeValue() The value of this node, depending on its type; see the table above.
final Document	getOwnerDocument() The Document object associated with this node.
final Element	getParentElement() Gets the parent element of this node.
final Node	getParentNode() The parent of this node.
final Node	getPreviousSibling() The node immediately preceding this node.
final boolean	hasChildNodes() Returns whether this node has any children.
final boolean	hasParentElement() Determines whether this node has a parent element.
final Node	insertAfter(Node newChild, Node refChild) Inserts the node newChild after the existing child node refChild.
final Node	insertBefore(Node newChild, Node refChild) Inserts the node newChild before the existing child node refChild.
final Node	insertFirst(Node child) Inserts the given child as the first child of this node.
static boolean	is(JavaScriptObject o) Determines whether the given `JavaScriptObject` is a DOM node.
final boolean	isOrHasChild(Node child) Determine whether a node is equal to, or the child of, this node.
final Node	removeChild(Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
final void	removeFromParent() Removes this node from its parent node if it is attached to one.
final Node	replaceChild(Node newChild, Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
final void	setNodeValue(String nodeValue) The value of this node, depending on its type; see the table above.

From class com.google.gwt.core.client.JavaScriptObject

From class java.lang.Object

Constants

public static final String CANNOT_PLAY

Constant returned from canPlayType(String).

Constant Value: ""

public static final String CAN_PLAY_MAYBE

Constant returned from canPlayType(String).

Constant Value: "maybe"

public static final String CAN_PLAY_PROBABLY

Constant returned from canPlayType(String).

Constant Value: "probably"

public static final int HAVE_CURRENT_DATA

Constant returned from getReadyState().

Constant Value: 2 (0x00000002)

public static final int HAVE_ENOUGH_DATA

Constant returned from getReadyState().

Constant Value: 4 (0x00000004)

public static final int HAVE_FUTURE_DATA

Constant returned from getReadyState().

Constant Value: 3 (0x00000003)

public static final int HAVE_METADATA

Constant returned from getReadyState().

Constant Value: 1 (0x00000001)

public static final int HAVE_NOTHING

Constant returned from getReadyState().

Constant Value: 0 (0x00000000)

public static final int NETWORK_EMPTY

Constant returned from getNetworkState().

Constant Value: 0 (0x00000000)

public static final int NETWORK_IDLE

Constant returned from getNetworkState().

Constant Value: 1 (0x00000001)

public static final int NETWORK_LOADING

Constant returned from getNetworkState().

Constant Value: 2 (0x00000002)

public static final int NETWORK_NO_SOURCE

Constant returned from getNetworkState().

Constant Value: 3 (0x00000003)

public static final String PRELOAD_AUTO

Constant used by getPreload() and setPreload(String).

Constant Value: "auto"

public static final String PRELOAD_METADATA

Constant used by getPreload() and setPreload(String).

Constant Value: "metadata"

public static final String PRELOAD_NONE

Constant used by getPreload() and setPreload(String).

Constant Value: "none"

Protected Constructors

protected MediaElement ()

Public Methods

public final String canPlayType (String type)

Returns true 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 CAN_PLAY_PROBABLY, CAN_PLAY_MAYBE, or CANNOT_PLAY

public final TimeRanges getBuffered ()

Returns a TimeRanges object indicating which portions of the source have been buffered locally.

Returns

a TimeRanges instance, or null.

public final String getCurrentSrc ()

Returns the URL of the current media source, or the empty String if no source is set.

Returns

a String URL

public final double getCurrentTime ()

Returns the current time within the source media stream.

Returns

the time, in seconds, as a double

public final 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

public final double getDuration ()

Returns the duration of the source media stream, in seconds. If the duration is unknown, NaN is returned. For unbounded media streams, POSITIVE_INFINITY is returned.

Returns

a positive duration in seconds, NaN, or Infinity

public final MediaError 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, or null

public final 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

public final int getNetworkState ()

Returns the network state, one of NETWORK_EMPTY, NETWORK_IDLE, NETWORK_LOADING, or NETWORK_NO_SOURCE.

Returns

an integer constant indicating the network state

public final 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

public final TimeRanges getPlayed ()

Returns a TimeRanges object indicating which portions of the source have been played.

Returns

a TimeRanges instance, or null.

public final String getPreload ()

Returns the preload setting, one of PRELOAD_AUTO, PRELOAD_METADATA, or PRELOAD_NONE.

Returns

the preload setting

public final int getReadyState ()

Returns the current state of the media with respect to rendering the current playback position, as one of the constants HAVE_CURRENT_DATA, HAVE_ENOUGH_DATA, HAVE_FUTURE_DATA, HAVE_METADATA, or HAVE_NOTHING .

Returns

an integer constant indicating the ready state

public final TimeRanges getSeekable ()

Returns a TimeRanges object indicating which portions of the source are seekable.

Returns

a TimeRanges instance, or null.

public final String getSrc ()

Returns the source URL for the media, or null if none is set.

Returns

a String URL or null

public final double getStartOffsetTime ()

Returns the time corresponding to the zero time in the media timeline, measured in seconds since midnight, January 1 1970 UTC, or NaN if none is specified.

Returns

the start time

public final 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)

public final boolean hasControls ()

Returns true 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

public final boolean hasEnded ()

Returns true if playback has reached the end of the media, false otherwise.

Returns

whether playback has ended

public final boolean isAutoplay ()

Returns true 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

public final boolean isLoop ()

Returns true if the user agent is to seek back to the start of the media once playing has ended, false otherwise.

Returns

the loop setting

public final boolean isMuted ()

Returns true if the volume is to be muted (overriding the normal volume setting), false otherwise.

Returns

the muting setting

public final boolean isPaused ()

Returns true if playback is paused, false otherwise.

Returns

the paused setting

public final boolean isSeeking ()

Returns true 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

public final void load ()

Causes the resource to be loaded.

public final void pause ()

Causes playback of the resource to be paused.

public final void play ()

Causes playback of the resource to be started or resumed.

public final void setAutoplay (boolean autoplay)

Enables or disables autoplay of the resource.

Parameters

autoplay	if `true`, enable autoplay

public final void setControls (boolean controls)

Enables or disables interactive controls.

Parameters

controls	if `true`, enable controls

public final void setCurrentTime (double time)

Sets the current playback time within the media stream, in seconds.

Parameters

time	a number within the ranges given by `getSeekable()`

public final void setDefaultPlaybackRate (double rate)

Sets the default playback rate.

Parameters

rate	a double value

public final void setLoop (boolean loop)

Enables or disables looping.

Parameters

loop	if `true`, enable looping

public final void setMuted (boolean muted)

Enables or disables muting.

Parameters

muted	if `true`, enable muting

public final void setPlaybackRate (double rate)

Sets the playback rate.

Parameters

rate	a double value

public final void setPreload (String preload)

Changes the preload setting to one of PRELOAD_AUTO, PRELOAD_METADATA, or PRELOAD_NONE.

Parameters

preload	a String constants

public final void setSrc (String url)

Sets the source URL for the media.

Parameters

url	a String URL

public final void setVolume (double volume)

Sets the playback volume.

Parameters

volume	a value between 0.0 (silent) and 1.0 (loudest)

Interfaces

Classes

Annotations

Enums

MediaElement

Class Overview

Summary

Constants

public static final String CANNOT_PLAY

public static final String CAN_PLAY_MAYBE

public static final String CAN_PLAY_PROBABLY

public static final int HAVE_CURRENT_DATA

public static final int HAVE_ENOUGH_DATA

public static final int HAVE_FUTURE_DATA

public static final int HAVE_METADATA

public static final int HAVE_NOTHING

public static final int NETWORK_EMPTY

public static final int NETWORK_IDLE

public static final int NETWORK_LOADING

public static final int NETWORK_NO_SOURCE

public static final String PRELOAD_AUTO

public static final String PRELOAD_METADATA

public static final String PRELOAD_NONE

Protected Constructors

protected MediaElement ()

Public Methods

public final String canPlayType (String type)

Parameters

Returns

public final TimeRanges getBuffered ()

Returns

public final String getCurrentSrc ()

Returns

public final double getCurrentTime ()

Returns

See Also

public final double getDefaultPlaybackRate ()

Returns

See Also

public final double getDuration ()

Returns

public final MediaError getError ()

Returns

public final double getInitialTime ()

Returns

public final int getNetworkState ()

Returns

See Also

public final double getPlaybackRate ()

Returns

See Also

public final TimeRanges getPlayed ()

Returns

public final String getPreload ()

Returns

See Also

public final int getReadyState ()

Returns

See Also

public final TimeRanges getSeekable ()

Returns

public final String getSrc ()

Returns

See Also

public final double getStartOffsetTime ()

Returns

public final double getVolume ()

Returns

See Also

public final boolean hasControls ()

Returns

See Also

public final boolean hasEnded ()

Returns

public final boolean isAutoplay ()

Returns

See Also

public final boolean isLoop ()

Returns

See Also