com.gargoylesoftware.htmlunit.javascript.host.html

Class HTMLMediaElement

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

com.gargoylesoftware.htmlunit.javascript.host.dom.Node

com.gargoylesoftware.htmlunit.javascript.host.Element

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLMediaElement

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

Direct Known Subclasses:

HTMLAudioElement, HTMLVideoElement

public class HTMLMediaElement
extends HTMLElement

The JavaScript object HTMLMediaElement.

Author:

Ahmed Ashour, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

HTMLElement.ProxyDomNode

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
static short	HAVE_CURRENT_DATA Data is available for the current playback position, but not enough to actually play more than one frame.
static short	HAVE_ENOUGH_DATA Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.
static short	HAVE_FUTURE_DATA Data for the current playback position as well as for at least a little bit of time into the future is available (in other words, at least two frames of video, for example).
static short	HAVE_METADATA Enough of the media resource has been retrieved that the metadata attributes are initialized.
static short	HAVE_NOTHING No information is available about the media resource.
static short	NETWORK_EMPTY There is no data yet.
static short	NETWORK_IDLE Network is idle.
static short	NETWORK_LOADING The media is loading.
static short	NETWORK_NO_SOURCE There is no source.

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
HTMLMediaElement() Creates an instance.

Method Summary

Modifier and Type	Method and Description
String	canPlayType(String type) Determines whether the specified media type can be played back.
String	getCurrentSrc() Returns the absolute URL of the chosen media resource.
String	getNodeName() Gets the JavaScript property nodeName for the current node.
protected String	getNodeNameCustomize()
short	getNodeType() Gets the JavaScript property nodeType for the current node.
String	getSrc() Returns the URL of the audio to embed.
void	load() Resets the media element to its initial state and begins the process of selecting a media source and loading the media in preparation for playback to begin at the beginning.
void	pause() Pauses playback of the media.
Object	play() Begins playback of the media.
void	setSrc(String src) Sets the value of the src attribute.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

blur, clearAttributes, click, contains, focus, getAccessKey, getAlign, getAttributeNode, getBoundingClientRect, getCh, getChildren, getChOff, getClassList, getClassName_js, getContentEditable, getCurrentStyle, getDataset, getDir, getDomNodeOrDie, getDomNodeOrNull, getElementsByClassName, getEnterKeyHint, getForm, getId, getInnerHTML, getInnerText, getLang, getLanguage, getLocalName, getName, getOffsetHeight, getOffsetLeft, getOffsetParent_js, getOffsetTop, getOffsetWidth, getOnabort, getOnactivate, getOnanimationcancel, getOnanimationend, getOnanimationiteration, getOnanimationstart, getOnauxclick, getOnbeforeactivate, getOnbeforecopy, getOnbeforecut, getOnbeforedeactivate, getOnbeforepaste, getOnblur, getOncancel, getOncanplay, getOncanplaythrough, getOnchange, getOnclick, getOnclose, getOncontextmenu, getOncopy, getOncuechange, getOncut, getOndblclick, getOndeactivate, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOndurationchange, getOnemptied, getOnended, getOnerror, getOnfocus, getOnfocusin, getOnfocusout, getOngotpointercapture, getOnhelp, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnloadeddata, getOnloadedmetadata, getOnloadstart, getOnlostpointercapture, getOnmousedown, getOnmouseenter, getOnmouseleave, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnmozfullscreenchange, getOnmozfullscreenerror, getOnmscontentzoom, getOnmsmanipulationstatechanged, getOnpaste, getOnpause, getOnplay, getOnplaying, getOnpointercancel, getOnpointerdown, getOnpointerenter, getOnpointerleave, getOnpointermove, getOnpointerout, getOnpointerover, getOnpointerup, getOnprogress, getOnratechange, getOnreset, getOnresize, getOnscroll, getOnseeked, getOnseeking, getOnselect, getOnselectionchange, getOnselectstart, getOnstalled, getOnsubmit, getOnsuspend, getOntimeupdate, getOntoggle, getOntransitioncancel, getOntransitionend, getOntransitionrun, getOntransitionstart, getOnvolumechange, getOnwaiting, getOnwheel, getOuterHTML, getOuterText, getParentElement, getParentHTMLElement, getPosX, getPosY, getPrefix, getRuntimeStyle, getStyle, getTabIndex, getTitle, getUniqueID, getVAlign, getValue, getWidthOrHeight, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isAncestorOfEventTarget, isDisabled, isEndTagForbidden, isHidden, isIsContentEditable, isLowerCaseInOuterHtml, isSpellcheck, mergeAttributes, readAttributes, releaseCapture, removeNode, scrollIntoView, setAccessKey, setActive, setAlign, setAttribute, setCapture, setCh, setChOff, setClassName_js, setColorAttribute, setContentEditable, setDir, setDisabled, setDomNode, setEnterKeyHint, setHidden, setId, setInnerHTML, setInnerText, setLang, setLanguage, setName, setOnabort, setOnactivate, setOnanimationcancel, setOnanimationend, setOnanimationiteration, setOnanimationstart, setOnauxclick, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforepaste, setOnblur, setOncancel, setOncanplay, setOncanplaythrough, setOnchange, setOnclick, setOnclose, setOncontextmenu, setOncopy, setOncuechange, setOncut, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOndurationchange, setOnemptied, setOnended, setOnerror, setOnfocus, setOnfocusin, setOnfocusout, setOngotpointercapture, setOnhelp, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnloadeddata, setOnloadedmetadata, setOnloadstart, setOnlostpointercapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmozfullscreenchange, setOnmozfullscreenerror, setOnmscontentzoom, setOnmsmanipulationstatechanged, setOnpaste, setOnpause, setOnplay, setOnplaying, setOnpointercancel, setOnpointerdown, setOnpointerenter, setOnpointerleave, setOnpointermove, setOnpointerout, setOnpointerover, setOnpointerup, setOnprogress, setOnratechange, setOnreset, setOnresize, setOnscroll, setOnseeked, setOnseeking, setOnselect, setOnselectionchange, setOnselectstart, setOnstalled, setOnsubmit, setOnsuspend, setOntimeupdate, setOntoggle, setOntransitioncancel, setOntransitionend, setOntransitionrun, setOntransitionstart, setOnvolumechange, setOnwaiting, setOnwheel, setOuterHTML, setSpellcheck, setStyle, setTabIndex, setTextContent, setTitle, setVAlign, setValue, setWidthOrHeight, toString

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Element

after, before, closest, createAttributesObject, createEventHandler, createTextRange, get, getAttribute, getAttributeNodeNS, getAttributeNS, getAttributes, getChildElementCount, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getInnerHTML, getLastElementChild, getNamespaceURI, getNextElementSibling, getOnmsgesturechange, getOnmsgesturedoubletap, getOnmsgestureend, getOnmsgesturehold, getOnmsgesturestart, getOnmsgesturetap, getOnmsgotpointercapture, getOnmsinertiastart, getOnmslostpointercapture, getOnmspointercancel, getOnmspointerdown, getOnmspointerenter, getOnmspointerleave, getOnmspointermove, getOnmspointerout, getOnmspointerover, getOnmspointerup, getOnsearch, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getTagName, hasAttribute, hasAttributeNS, hasAttributes, innerHTML, isDisplayNone, matches, mozMatchesSelector, msMatchesSelector, printChildren, printNode, querySelector, querySelectorAll, remove, removeAttribute, removeAttributeNode, removeAttributeNS, replaceWith, scrollIntoViewIfNeeded, setAttributeNode, setAttributeNS, setOnmsgesturechange, setOnmsgesturedoubletap, setOnmsgestureend, setOnmsgesturehold, setOnmsgesturestart, setOnmsgesturetap, setOnmsgotpointercapture, setOnmsinertiastart, setOnmslostpointercapture, setOnmspointercancel, setOnmspointerdown, setOnmspointerenter, setOnmspointerleave, setOnmspointermove, setOnmspointerout, setOnmspointerover, setOnmspointerup, setOnsearch, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setScrollLeft, setScrollTop, toggleAttribute, webkitMatchesSelector

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

appendChild, asJavaScriptException, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFirstChild, getJavaScriptNode, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParent, getParentNode, getPreviousSibling, getRootNode, getTextContent, hasChildNodes, insertBefore, insertBeforeImpl, isSameNode, normalize, removeChild, replaceChild, setNodeValue

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

addEventListener, clearEventListenersContainer, dispatchEvent, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

clone, equivalentValues, getBrowserVersion, getClassName, getDefaultValue, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HAVE_NOTHING

public static final short HAVE_NOTHING

No information is available about the media resource.

See Also:

Constant Field Values

HAVE_METADATA

public static final short HAVE_METADATA

Enough of the media resource has been retrieved that the metadata attributes are initialized. Seeking will no longer raise an exception.

See Also:

Constant Field Values

HAVE_CURRENT_DATA

public static final short HAVE_CURRENT_DATA

Data is available for the current playback position, but not enough to actually play more than one frame.

See Also:

Constant Field Values

HAVE_FUTURE_DATA

public static final short HAVE_FUTURE_DATA

Data for the current playback position as well as for at least a little bit of time into the future is available (in other words, at least two frames of video, for example).

See Also:

Constant Field Values

HAVE_ENOUGH_DATA

public static final short HAVE_ENOUGH_DATA

Enough data is available—and the download rate is high enough—that the media can be played through to the end without interruption.

See Also:

Constant Field Values

NETWORK_EMPTY

public static final short NETWORK_EMPTY

There is no data yet.

See Also:

Constant Field Values

NETWORK_IDLE

public static final short NETWORK_IDLE

Network is idle.

See Also:

Constant Field Values

NETWORK_LOADING

public static final short NETWORK_LOADING

The media is loading.

See Also:

Constant Field Values

NETWORK_NO_SOURCE

public static final short NETWORK_NO_SOURCE

There is no source.

See Also:

Constant Field Values

Constructor Detail

HTMLMediaElement

public HTMLMediaElement()

Creates an instance.

Method Detail

canPlayType

public String canPlayType(String type)

Determines whether the specified media type can be played back.

Parameters:

type - the type

Returns:

"probably", "maybe", or ""

play

public Object play()

Begins playback of the media.

Returns:

a Promise which is fulfilled when playback has been started, or is rejected if for any reason playback cannot be started

pause

public void pause()

Pauses playback of the media.

load

public void load()

Resets the media element to its initial state and begins the process of selecting a media source and loading the media in preparation for playback to begin at the beginning.

getNodeType

public short getNodeType()

Gets the JavaScript property nodeType for the current node.

Overrides:

getNodeType in class Node

Returns:

the node type

getNodeName

public String getNodeName()

Gets the JavaScript property nodeName for the current node.

Overrides:

getNodeName in class HTMLElement

Returns:

the node name

getNodeNameCustomize

protected String getNodeNameCustomize()

getSrc

public String getSrc()

Returns the URL of the audio to embed.

Returns:

the value of the src attribute

setSrc

public void setSrc(String src)

Sets the value of the src attribute.

Parameters:

src - the value of the src attribute

getCurrentSrc

public String getCurrentSrc()

Returns the absolute URL of the chosen media resource. This could happen, for example, if the web server selects a media file based on the resolution of the user's display. The value is an empty string if the networkState property is EMPTY.

Returns:

the absolute URL of the chosen media resource